API reference

audio_adapter.h · C++ API

Browse entries grouped by interface file. Expand an entry for declarations, usage and version boundaries.

Read the related guide →

Entries retain declarations and sources. Runtime verification is recorded per entry; internal source candidates are not a promise of SDK delivery.

include/kui/media/audio_adapter.h
AudioAdapter::~AudioAdapter
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
~AudioAdapter() override;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:20

Report an issue with this entry →
AudioAdapter::AudioAdapter
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
AudioAdapter(AudioAdapter&& other) noexcept;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:22

Report an issue with this entry →
AudioAdapter::AudioAdapter
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
AudioAdapter() = default;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:19

Report an issue with this entry →
AudioAdapter::createPlayer
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
KuiAudioPlayer createPlayer();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:36

Report an issue with this entry →
AudioAdapter::currentTime
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
double currentTime(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:54

Report an issue with this entry →
AudioAdapter::destroyPlayer
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void destroyPlayer(KuiAudioPlayer player);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:38

Report an issue with this entry →
AudioAdapter::duration
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
double duration(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:57

Report an issue with this entry →
AudioAdapter::getError
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
const char* getError(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:52

Report an issue with this entry →
AudioAdapter::hasError
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
bool hasError(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:51

Report an issue with this entry →
AudioAdapter::isAvailable
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
bool isAvailable() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:31

Report an issue with this entry →
AudioAdapter::isEnded
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
bool isEnded(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:50

Report an issue with this entry →
AudioAdapter::isLooping
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
bool isLooping(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:67

Report an issue with this entry →
AudioAdapter::isMuted
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
bool isMuted(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:63

Report an issue with this entry →
AudioAdapter::isPlaying
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
bool isPlaying(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:48

Report an issue with this entry →
AudioAdapter::load
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
bool load(const std::string& dllPath = "kui_media_audio");

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:26

Report an issue with this entry →
AudioAdapter::loadFile
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
KuiMediaError loadFile(KuiAudioPlayer player, const char* path);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:40

Report an issue with this entry →
AudioAdapter::operator=
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
AudioAdapter& operator=(AudioAdapter&& other) noexcept;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:24

Report an issue with this entry →
AudioAdapter::pan
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
float pan(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:71

Report an issue with this entry →
AudioAdapter::pause
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void pause(KuiAudioPlayer player);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:45

Report an issue with this entry →
AudioAdapter::pitch
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
float pitch(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:75

Report an issue with this entry →
AudioAdapter::play
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void play(KuiAudioPlayer player);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:43

Report an issue with this entry →
AudioAdapter::pluginInfo
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
KuiMediaPluginInfo pluginInfo() const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:33

Report an issue with this entry →
AudioAdapter::seek
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void seek(KuiAudioPlayer player, double seconds);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:56

Report an issue with this entry →
AudioAdapter::setLooping
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void setLooping(KuiAudioPlayer player, bool loop);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:65

Report an issue with this entry →
AudioAdapter::setMuted
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void setMuted(KuiAudioPlayer player, bool muted);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:62

Report an issue with this entry →
AudioAdapter::setPan
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void setPan(KuiAudioPlayer player, float pan);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:69

Report an issue with this entry →
AudioAdapter::setPitch
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void setPitch(KuiAudioPlayer player, float pitch);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:73

Report an issue with this entry →
AudioAdapter::setVolume
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void setVolume(KuiAudioPlayer player, float vol);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:59

Report an issue with this entry →
AudioAdapter::stop
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void stop(KuiAudioPlayer player);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:46

Report an issue with this entry →
AudioAdapter::tick
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void tick(KuiAudioPlayer player, double dt);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:77

Report an issue with this entry →
AudioAdapter::unload
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
void unload();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:30

Report an issue with this entry →
AudioAdapter::volume
Needs verification3.61.7C++

Installed header declaration in the media module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

audio_adapter.h
float volume(KuiAudioPlayer player) const;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/media/audio_adapter.h:61

Report an issue with this entry →
Browse this reference type →