Class: Groove::Player::GroovePlayer

Inherits:
FFI::Struct
  • Object
show all
Defined in:
lib/groove/player.rb

Overview

(Not documented)

Fields:

:device_index

(Integer) set this to the device you want to open could also be GROOVE_PLAYER_DEFAULT_DEVICE or GROOVE_PLAYER_DUMMY_DEVICE

:target_audio_format

(unknown) The desired audio format settings with which to open the device. groove_player_create defaults these to 44100 Hz, signed 16-bit int, 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.

:device_buffer_size

(Integer) how big the device buffer should be, in sample frames. must be a power of 2. groove_player_create defaults this to 1024

:sink_buffer_size

(Integer) how big the sink buffer should be, in sample frames. groove_player_create defaults this to 8192

:gain

(Float) This 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

:playlist

(FFI::Pointer(*GroovePlaylist)) read-only. set when you call groove_player_attach and cleared when you call groove_player_detach

:actual_audio_format

(unknown) 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.