mirror of
https://github.com/SFML/SFML.git
synced 2024-12-01 07:41:05 +08:00
111 lines
4.1 KiB
C++
111 lines
4.1 KiB
C++
////////////////////////////////////////////////////////////
|
|
//
|
|
// SFML - Simple and Fast Multimedia Library
|
|
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
|
|
//
|
|
// This software is provided 'as-is', without any express or implied warranty.
|
|
// In no event will the authors be held liable for any damages arising from the use of this software.
|
|
//
|
|
// Permission is granted to anyone to use this software for any purpose,
|
|
// including commercial applications, and to alter it and redistribute it freely,
|
|
// subject to the following restrictions:
|
|
//
|
|
// 1. The origin of this software must not be misrepresented;
|
|
// you must not claim that you wrote the original software.
|
|
// If you use this software in a product, an acknowledgment
|
|
// in the product documentation would be appreciated but is not required.
|
|
//
|
|
// 2. Altered source versions must be plainly marked as such,
|
|
// and must not be misrepresented as being the original software.
|
|
//
|
|
// 3. This notice may not be removed or altered from any source distribution.
|
|
//
|
|
////////////////////////////////////////////////////////////
|
|
|
|
#pragma once
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Headers
|
|
////////////////////////////////////////////////////////////
|
|
#include <SFML/Audio/Export.hpp>
|
|
|
|
#include <optional>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
|
|
namespace sf::PlaybackDevice
|
|
{
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get a list of the names of all available audio playback devices
|
|
///
|
|
/// This function returns a vector of strings containing
|
|
/// the names of all available audio playback devices.
|
|
///
|
|
/// If the operating system reports multiple devices with
|
|
/// the same name, a number will be appended to the name
|
|
/// of all subsequent devices to distinguish them from each
|
|
/// other. This guarantees that every entry returned by this
|
|
/// function will represent a unique device.
|
|
///
|
|
/// For example, if the operating system reports multiple
|
|
/// devices with the name "Sound Card", the entries returned
|
|
/// would be:
|
|
/// - Sound Card
|
|
/// - Sound Card 2
|
|
/// - Sound Card 3
|
|
/// - ...
|
|
///
|
|
/// The default device, if one is marked as such, will be
|
|
/// placed at the beginning of the vector.
|
|
///
|
|
/// If no devices are available, this function will return
|
|
/// an empty vector.
|
|
///
|
|
/// \return A vector of strings containing the device names or an empty vector if no devices are available
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] SFML_AUDIO_API std::vector<std::string> getAvailableDevices();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the name of the default audio playback device
|
|
///
|
|
/// This function returns the name of the default audio
|
|
/// playback device. If none is available, an empty string
|
|
/// is returned.
|
|
///
|
|
/// \return The name of the default audio playback device
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] SFML_AUDIO_API std::optional<std::string> getDefaultDevice();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Set the audio playback device
|
|
///
|
|
/// This function sets the audio playback device to the device
|
|
/// with the given \a `name`. It can be called on the fly (i.e:
|
|
/// while sounds are playing).
|
|
///
|
|
/// If there are sounds playing when the audio playback
|
|
/// device is switched, the sounds will continue playing
|
|
/// uninterrupted on the new audio playback device.
|
|
///
|
|
/// \param name The name of the audio playback device
|
|
///
|
|
/// \return `true`, if it was able to set the requested device
|
|
///
|
|
/// \see `getAvailableDevices`, `getDefaultDevice`
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] SFML_AUDIO_API bool setDevice(const std::string& name);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// \brief Get the name of the current audio playback device
|
|
///
|
|
/// \return The name of the current audio playback device or `std::nullopt` if there is none
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
[[nodiscard]] SFML_AUDIO_API std::optional<std::string> getDevice();
|
|
|
|
} // namespace sf::PlaybackDevice
|