SFML - Simple and Fast Multimedia Library

SFML 3.0.2
Loading...
Searching...
No Matches
PlaybackDevice.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2025 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#pragma once
26
28// Headers
30#include <SFML/Audio/Export.hpp>
31
32#include <optional>
33#include <string>
34#include <vector>
35
36
37 namespace sf::PlaybackDevice
38{
68[[nodiscard]] SFML_AUDIO_API std::vector<std::string> getAvailableDevices();
69
80[[nodiscard]] SFML_AUDIO_API std::optional<std::string> getDefaultDevice();
81
100[[nodiscard]] SFML_AUDIO_API bool setDevice(const std::string& name);
101
108[[nodiscard]] SFML_AUDIO_API std::optional<std::string> getDevice();
109
110} // namespace sf::PlaybackDevice
Export.hpp
SFML_AUDIO_API
#define SFML_AUDIO_API
Definition Audio/Export.hpp:42
sf::PlaybackDevice
Definition PlaybackDevice.hpp:38
sf::PlaybackDevice::getDefaultDevice
std::optional< std::string > getDefaultDevice()
Get the name of the default audio playback device.
sf::PlaybackDevice::setDevice
bool setDevice(const std::string &name)
Set the audio playback device.
sf::PlaybackDevice::getDevice
std::optional< std::string > getDevice()
Get the name of the current audio playback device.
sf::PlaybackDevice::getAvailableDevices
std::vector< std::string > getAvailableDevices()
Get a list of the names of all available audio playback devices.