libgroove  5.0.0
GroovePlayer Struct Reference

Data Fields

struct SoundIoDevice * device
 Set this to the device you want to open. More...
 
struct GrooveAudioFormat target_audio_format
 The desired audio format settings with which to open the device. More...
 
double gain
 Volume adjustment to make to this player. More...
 
struct GroovePlaylistplaylist
 read-only. More...
 
struct GrooveAudioFormat actual_audio_format
 read-only. More...
 
int use_exact_audio_format
 If you set this to 1, target_audio_format and actual_audio_format are ignored and no resampling, channel layout remapping, or sample format conversion will occur. More...
 

Detailed Description

Examples:
playlist.c.

Field Documentation

struct GrooveAudioFormat GroovePlayer::actual_audio_format

read-only.

set to the actual format you get when you open the device. ideally will be the same as target_audio_format but might not be.

struct SoundIoDevice* GroovePlayer::device

Set this to the device you want to open.

You may use NULL for default. If you set use_dummy_device to 1, this field is ignored.

Examples:
playlist.c.
double GroovePlayer::gain

Volume adjustment to make to this player.

It is recommended that you leave this at 1.0 and instead adjust the gain of the underlying playlist. If you want to change this value after you have already attached the sink to the playlist, you must use groove_player_set_gain. float format. Defaults to 1.0

struct GroovePlaylist* GroovePlayer::playlist

read-only.

set when you call groove_player_attach and cleared when you call groove_player_detach

struct GrooveAudioFormat GroovePlayer::target_audio_format

The desired audio format settings with which to open the device.

groove_player_create defaults these to 48000 Hz, signed 32-bit native endian integer, stereo. These are preferences; if a setting cannot be used, a substitute will be used instead. actual_audio_format is set to the actual values. If you set use_exact_audio_format to 1, this field is ignored.

int GroovePlayer::use_exact_audio_format

If you set this to 1, target_audio_format and actual_audio_format are ignored and no resampling, channel layout remapping, or sample format conversion will occur.

The audio device will be reopened with exact parameters whenever necessary.

Examples:
playlist.c.

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