Preferences. More...

Functions
livesString	currentVideoLoadDir (const livesApp &lives)

livesString	currentAudioDir (const livesApp &lives)

livesString	tmpDir (const livesApp &lives)
	Despite the name, this is the working directory for the LiVES application. More...

lives_audio_source_t	audioSource (const livesApp &lives)

bool	setAudioSource (const livesApp &lives, lives_audio_source_t asrc)
	Set the audio source. More...

lives_audio_player_t	audioPlayer (const livesApp &lives)

int	audioPlayerRate (const livesApp &lives)
	Returns the audio rate for the player. More...

bool	isRealtimeAudioPlayer (lives_audio_player_t ptype)

int	rteKeysVirtual (const livesApp &lives)

double	maxFPS (const livesApp &lives)

bool	audioFollowsVideoChanges (const livesApp &lives)

bool	audioFollowsFPSChanges (const livesApp &lives)

bool	setAudioFollowsVideoChanges (const livesApp &lives, bool setting)

bool	setAudioFollowsFPSChanges (const livesApp &lives, bool setting)

bool	sepWinSticky (const livesApp &lives)

bool	setSepWinSticky (const livesApp &lives, bool)

bool	mtExitRender (const livesApp &lives)

bool	setMtExitRender (const livesApp &lives, bool setting)

Detailed Description

Preferences.

Valid values are only returned if the livesApp::isValid() is true, and livesApp::status() is not LIVES_STATUS_NOTREADY. Implementation note: we use const livesApp & here to avoid the destructor being called on a copy object, which would cause LiVES to terminate prematurely.

Function Documentation

bool lives::prefs::audioFollowsFPSChanges ( const livesApp & lives )

Parameters

lives a reference to a valid livesApp instance

Returns: true if the clip audio playback rate changes to match video clip framerate changes during playback

See Also: setAudioFollowsFPSChanges().

bool lives::prefs::audioFollowsVideoChanges ( const livesApp & lives )

Parameters

lives a reference to a valid livesApp instance

Returns: true if the audio clip changes to match video clip changes during playback

See Also: setAudioFollowsVideoChanges().

lives_audio_player_t lives::prefs::audioPlayer ( const livesApp & lives )

Parameters

lives a reference to a livesApp instance

Returns: the current audio player

int lives::prefs::audioPlayerRate ( const livesApp & lives )

Returns the audio rate for the player.

Note this may be different from the clip audio rate. Only valid if isRealtimeAudioPlayer(lives.audioPlayer()) is true.

Parameters

lives a reference to a livesApp instance

Returns: the current audio player rate in Hz.

See Also: isRealtimeAudioPlayer()

lives_audio_source_t lives::prefs::audioSource ( const livesApp & lives )

Parameters

lives a reference to a valid livesApp instance

Returns: the current audio source

See Also: setAudioSource().

livesString lives::prefs::currentAudioDir ( const livesApp & lives )

Parameters

lives a reference to a valid const livesApp &instance

Returns: the currently preferred directory for loading and saving audio.

livesString lives::prefs::currentVideoLoadDir ( const livesApp & lives )

Parameters

lives a reference to a valid livesApp instance

Returns: the currently preferred directory for loading video clips.

bool lives::prefs::isRealtimeAudioPlayer ( lives_audio_player_t ptype )

Parameters

ptype an audio player type

Returns: true if the audio player type is realtime controllable

double lives::prefs::maxFPS ( const livesApp & lives )

Parameters

lives a reference to a valid livesApp instance

Returns: the maximum allowed framerate for a clip

bool lives::prefs::mtExitRender ( const livesApp & lives )

Parameters

lives a reference to a valid livesApp instance

Returns: true if the livesApp::mode() switches to LIVES_INTERFACE_MODE_CLIPEDIT after calling multitrack::render()

See Also: setMtExitRender(); multitrack::render()

int lives::prefs::rteKeysVirtual ( const livesApp & lives )

Parameters

lives a reference to a valid livesApp instance

Returns: the maximum value for effectKey indices

bool lives::prefs::sepWinSticky ( const livesApp & lives )

Parameters

lives a reference to a valid livesApp instance

Returns: true if the separate playback window is shown even when livesApp::isPlaying() is false.

See Also: setSepWinSticky(); player::sepWin()

bool lives::prefs::setAudioFollowsFPSChanges	(	const livesApp &	lives,
		bool	setting
	)

Parameters

lives	a reference to a valid livesApp instance
setting	the new setting

Returns: true if the preference was updated

See Also: audioFollowsFPSChanges

bool lives::prefs::setAudioFollowsVideoChanges	(	const livesApp &	lives,
		bool	setting
	)

Parameters

lives	a reference to a valid livesApp instance
setting	the new setting

Returns: true if the preference was updated

See Also: audioFollowsFPSChanges

bool lives::prefs::setAudioSource	(	const livesApp &	lives,
		lives_audio_source_t	asrc
	)

Set the audio source.

Only works if livesApp::status() is LIVES_STATUS_READY.

Parameters

lives	a reference to a valid livesApp instance
asrc	the desired audio source

Returns: true if the audio source could be changed.

bool lives::prefs::setMtExitRender	(	const livesApp &	lives,
		bool	setting
	)

Parameters

lives	a reference to a valid livesApp instance
setting	the new setting

Returns: true if the preference was updated

See Also: mtExitRender().; multitrack::render().

bool lives::prefs::setSepWinSticky	(	const livesApp &	lives,
		bool
	)

Parameters

lives a reference to a valid livesApp instance

Returns: true if the preference was updated

See Also: sepWinSticky(); player::sepWin()

livesString lives::prefs::tmpDir ( const livesApp & lives )

Despite the name, this is the working directory for the LiVES application.

The valid list of sets is drawn from this directory, for it is here that they are saved and loaded. The value can only be set at runtime through the GUI preferences window. Otherwise you can override the default value when the livesApp() is created via argv[] option "-tmpdir", eg:

char *argv[2];
argv[0]="-tmpdir";
argv[1]="/home/user/tempdir/";
livesApp lives(2, argv);

Parameters

lives a reference to a valid livesApp instance

Returns: the LiVES working directory

Functions

Detailed Description

Function Documentation