SFML

- Main Page
- Modules
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Static Public Member Functions | List of all members
sf::Listener Class Reference
Audio module

The audio listener is the point in the scene from where all the sounds are heard. More...

`#include <Listener.hpp>`

## Static Public Member Functions
static void | setGlobalVolume (float volume)
| Change the global volume of all the sounds and musics. More...
static float | getGlobalVolume ()
| Get the current value of the global volume. More...
static void | setPosition (float x, float y, float z)
| Set the position of the listener in the scene. More...
static void | setPosition (const Vector3f &position)
| Set the position of the listener in the scene. More...
static Vector3f | getPosition ()
| Get the current position of the listener in the scene. More...
static void | setDirection (float x, float y, float z)
| Set the orientation of the listener in the scene. More...
static void | setDirection (const Vector3f &direction)
| Set the orientation of the listener in the scene. More...
static Vector3f | getDirection ()
| Get the current orientation of the listener in the scene. More...

## Detailed Description

The audio listener is the point in the scene from where all the sounds are heard.

The audio listener defines the global properties of the audio environment, it defines where and how sounds and musics are heard.

If sf::View is the eyes of the user, then sf::Listener is his ears (by the way, they are often linked together – same position, orientation, etc.).

sf::Listener is a simple interface, which allows to setup the listener in the 3D audio environment (position and direction), and to adjust the global volume.

Because the listener is unique in the scene, sf::Listener only contains static functions and doesn't have to be instanciated.

Usage example:

// Move the listener to the position (1, 0, -5)
sf::Listener::setPosition(1, 0, -5);
// Make it face the right axis (1, 0, 0)
sf::Listener::setDirection(1, 0, 0);
// Reduce the global volume
sf::Listener::setGlobalVolume(50);

Definition at line 42 of file Listener.hpp.

## Member Function Documentation

static Vector3f sf::Listener::getDirection | ( | ) |  |
| static

Get the current orientation of the listener in the scene.

Returns
  Listener's orientation

See Also
  setDirection

static float sf::Listener::getGlobalVolume | ( | ) |  |
| static

Get the current value of the global volume.

Returns
  Current global volume, in the range [0, 100]

See Also
  setGlobalVolume

static Vector3f sf::Listener::getPosition | ( | ) |  |
| static

Get the current position of the listener in the scene.

Returns
  Listener's position

See Also
  setPosition

static void sf::Listener::setDirection | ( | float | x,
|  | float | y,
|  | float | z
| ) |  |
| static

Set the orientation of the listener in the scene.

The orientation defines the 3D axes of the listener (left, up, front) in the scene. The orientation vector doesn't have to be normalized. The default listener's orientation is (0, 0, -1).

Parameters

  x | X coordinate of the listener's orientation
  y | Y coordinate of the listener's orientation
  z | Z coordinate of the listener's orientation

See Also
  getDirection, setPosition

static void sf::Listener::setDirection | ( | const Vector3f & | direction) |  |
| static

Set the orientation of the listener in the scene.

The orientation defines the 3D axes of the listener (left, up, front) in the scene. The orientation vector doesn't have to be normalized. The default listener's orientation is (0, 0, -1).

Parameters

  direction | New listener's orientation

See Also
  getDirection, setPosition

static void sf::Listener::setGlobalVolume | ( | float | volume) |  |
| static

Change the global volume of all the sounds and musics.

The volume is a number between 0 and 100; it is combined with the individual volume of each sound / music. The default value for the volume is 100 (maximum).

Parameters

  volume | New global volume, in the range [0, 100]

See Also
  getGlobalVolume

static void sf::Listener::setPosition | ( | float | x,
|  | float | y,
|  | float | z
| ) |  |
| static

Set the position of the listener in the scene.

The default listener's position is (0, 0, 0).

Parameters

  x | X coordinate of the listener's position
  y | Y coordinate of the listener's position
  z | Z coordinate of the listener's position

See Also
  getPosition, setDirection

static void sf::Listener::setPosition | ( | const Vector3f & | position) |  |
| static

Set the position of the listener in the scene.

The default listener's position is (0, 0, 0).

Parameters

  position | New listener's position

See Also
  getPosition, setDirection

The documentation for this class was generated from the following file:

- Listener.hpp