*/
/*!
- \qmlproperty string QtAudioEngine1::AttenuationModelLinear::name
+ \qmlproperty string QtAudioEngine::AttenuationModelLinear::name
This property holds the name of AttenuationModelLinear, must be unique among all attenuation
models and only defined once.
}
/*!
- \qmlproperty real QtAudioEngine1::AttenuationModelLinear::start
+ \qmlproperty real QtAudioEngine::AttenuationModelLinear::start
This property holds the start distance. There will be no attenuation if the distance from sound
to listener is within this range.
}
/*!
- \qmlproperty real QtAudioEngine1::AttenuationModelLinear::end
+ \qmlproperty real QtAudioEngine::AttenuationModelLinear::end
This property holds the end distance. There will be no sound hearable if the distance from sound
to listener is larger than this.
*/
/*!
- \qmlproperty string QtAudioEngine1::AttenuationModelInverse::name
+ \qmlproperty string QtAudioEngine::AttenuationModelInverse::name
This property holds the name of AttenuationModelInverse, must be unique among all attenuation
models and only defined once.
*/
/*!
- \qmlproperty real QtAudioEngine1::AttenuationModelInverse::start
+ \qmlproperty real QtAudioEngine::AttenuationModelInverse::start
This property holds the start distance. There will be no attenuation if the distance from sound
to listener is within this range.
*/
/*!
- \qmlproperty real QtAudioEngine1::AttenuationModelInverse::end
+ \qmlproperty real QtAudioEngine::AttenuationModelInverse::end
This property holds the end distance. There will be no further attenuation if the distance from
sound to listener is larger than this.
*/
/*!
- \qmlproperty real QtAudioEngine1::AttenuationModelInverse::rolloff
+ \qmlproperty real QtAudioEngine::AttenuationModelInverse::rolloff
This property holds the rolloff factor. The bigger the value is, the faster the sound attenuates.
The default value is 1.
This type is part of the \b{QtAudioEngine 1.0} module.
- An instance of AudioCategory can be accessed through QtAudioEngine1::AudioEngine::categories with its
- unique name and must be defined inside AudioEngine.
+ An instance of AudioCategory can be accessed through \l {QtAudioEngine::AudioEngine::categories}
+ {AudioEngine.categories} with its unique name and must be defined inside AudioEngine.
\qml
import QtQuick 2.0
}
/*!
- \qmlproperty real QtAudioEngine1::AudioCategory::volume
+ \qmlproperty real QtAudioEngine::AudioCategory::volume
This property holds the volume of the category and will modulate all audio output from the
instances which belong to this category.
}
/*!
- \qmlproperty string QtAudioEngine1::AudioCategory::name
+ \qmlproperty string QtAudioEngine::AudioCategory::name
This property holds the name of AudioCategory. The name must be unique among all categories and only
defined once. The name cannot be changed after the instance has been initialized.
}
/*!
- \qmlmethod QtAudioEngine1::AudioCategory::stop()
+ \qmlmethod QtAudioEngine::AudioCategory::stop()
Stops all active sound instances which belong to this category.
*/
}
/*!
- \qmlmethod QtAudioEngine1::AudioCategory::pause()
+ \qmlmethod QtAudioEngine::AudioCategory::pause()
Pauses all active sound instances which belong to this category.
*/
}
/*!
- \qmlmethod QtAudioEngine1::AudioCategory::pause()
+ \qmlmethod QtAudioEngine::AudioCategory::pause()
Resumes all active sound instances from paused state which belong to this category.
*/
}
/*!
- \qmlproperty int QtAudioEngine1::AudioEngine::liveInstances
+ \qmlproperty int QtAudioEngine::AudioEngine::liveInstances
This property indicates how many live sound instances there are at the moment.
*/
}
/*!
- \qmlproperty map QtAudioEngine1::AudioEngine::categories
+ \qmlproperty map QtAudioEngine::AudioEngine::categories
Container of all AudioCategory instances.
*/
}
/*!
- \qmlproperty map QtAudioEngine1::AudioEngine::samples
+ \qmlproperty map QtAudioEngine::AudioEngine::samples
Container of all AudioSample instances.
*/
}
/*!
- \qmlproperty map QtAudioEngine1::AudioEngine::sounds
+ \qmlproperty map QtAudioEngine::AudioEngine::sounds
Container of all Sound instances.
*/
}
/*!
- \qmlproperty QtAudioEngine1::AudioListener QtAudioEngine1::AudioEngine::listener
+ \qmlproperty QtAudioEngine::AudioListener QtAudioEngine::AudioEngine::listener
This property holds the listener object. You can change various
properties to affect the 3D positioning of sounds.
}
/*!
- \qmlproperty real QtAudioEngine1::AudioEngine::dopplerFactor
+ \qmlproperty real QtAudioEngine::AudioEngine::dopplerFactor
This property holds a simple scaling for the effect of doppler shift.
*/
}
/*!
- \qmlproperty real QtAudioEngine1::AudioEngine::speedOfSound
+ \qmlproperty real QtAudioEngine::AudioEngine::speedOfSound
This property holds the reference value of the sound speed (in meters per second)
which will be used in doppler shift calculation. The doppler shift calculation is
}
/*!
- \qmlproperty bool QtAudioEngine1::AudioEngine::loading
+ \qmlproperty bool QtAudioEngine::AudioEngine::loading
This property indicates if the audio engine is loading any audio sample at the moment. This may
be useful if you specified the preloaded property in AudioSample and would like to show a loading screen
}
/*!
- \qmlsignal QtAudioEngine1::AudioEngine::finishedLoading()
+ \qmlsignal QtAudioEngine::AudioEngine::finishedLoading()
This signal is emitted when \l loading has completed.
*/
/*!
- \qmlsignal QtAudioEngine1::AudioEngine::ready()
+ \qmlsignal QtAudioEngine::AudioEngine::ready()
This signal is emitted when the AudioEngine is ready to use.
*/
/*!
- \qmlsignal QtAudioEngine1::AudioEngine::liveInstanceCountChanged()
+ \qmlsignal QtAudioEngine::AudioEngine::liveInstanceCountChanged()
This signal is emitted when the number of live instances managed by the
AudioEngine is changed.
*/
/*!
- \qmlsignal QtAudioEngine1::AudioEngine::isLoadingChanged()
+ \qmlsignal QtAudioEngine::AudioEngine::isLoadingChanged()
This signal is emitted when the \l loading property changes.
}
/*!
- \qmlproperty QtAudioEngine1::AudioEngine QtAudioEngine1::AudioListener::engine
+ \qmlproperty QtAudioEngine::AudioEngine QtAudioEngine::AudioListener::engine
This property holds the reference to AudioEngine, must be set only once.
*/
}
/*!
- \qmlproperty vector3d QtAudioEngine1::AudioListener::position
+ \qmlproperty vector3d QtAudioEngine::AudioListener::position
This property holds the 3d position of the listener.
*/
}
/*!
- \qmlproperty vector3d QtAudioEngine1::AudioListener::direction
+ \qmlproperty vector3d QtAudioEngine::AudioListener::direction
This property holds the normalized 3d direction vector of the listener.
*/
}
/*!
- \qmlproperty vector3d QtAudioEngine1::AudioListener::velocity
+ \qmlproperty vector3d QtAudioEngine::AudioListener::velocity
This property holds the 3d velocity vector of the listener.
*/
}
/*!
- \qmlproperty vector3d QtAudioEngine1::AudioListener::up
+ \qmlproperty vector3d QtAudioEngine::AudioListener::up
This property holds the normalized 3d up vector of the listener.
*/
}
/*!
- \qmlproperty real QtAudioEngine1::AudioListener::gain
+ \qmlproperty real QtAudioEngine::AudioListener::gain
This property will modulate all audio output from audio engine instances.
*/
\c AudioSample is part of the \b{QtAudioEngine 1.0} module.
- It can be accessed through QtAudioEngine1::AudioEngine::samples with its unique
+ It can be accessed through QtAudioEngine::AudioEngine::samples with its unique
name and must be defined inside AudioEngine.
\qml
}
/*!
- \qmlproperty bool QtAudioEngine1::AudioSample::preloaded
+ \qmlproperty bool QtAudioEngine::AudioSample::preloaded
This property indicates whether this sample needs to be preloaded or not.
If true, the audio engine will start loading the sample file immediately when the app started,
}
/*!
- \qmlproperty bool QtAudioEngine1::AudioSample::loaded
+ \qmlproperty bool QtAudioEngine::AudioSample::loaded
This property indicates whether this sample has been loaded into memory or not.
*/
}
/*!
- \qmlmethod void QtAudioEngine1::AudioSample::load()
+ \qmlmethod void QtAudioEngine::AudioSample::load()
Starts loading the sample into memory if not loaded.
*/
}
/*!
- \qmlproperty string QtAudioEngine1::AudioSample::name
+ \qmlproperty string QtAudioEngine::AudioSample::name
This property holds the name of AudioSample, must be unique among all samples and only
defined once.
}
/*!
- \qmlsignal QtAudioEngine1::AudioSample::onLoadedChanged()
+ \qmlsignal QtAudioEngine::AudioSample::onLoadedChanged()
This handler is called when \l loaded is changed
*/
}
/*!
- \qmlproperty string QtAudioEngine1::PlayVariation::sample
+ \qmlproperty string QtAudioEngine::PlayVariation::sample
This property specifies which \l AudioSample this variation will use.
*/
}
/*!
- \qmlproperty bool QtAudioEngine1::PlayVariation::looping
+ \qmlproperty bool QtAudioEngine::PlayVariation::looping
This property indicates whether the playback will be looped or not.
*/
}
/*!
- \qmlproperty real QtAudioEngine1::PlayVariation::maxGain
+ \qmlproperty real QtAudioEngine::PlayVariation::maxGain
This property specifies the maximum gain adjustment that can be applied in any playback.
*/
}
/*!
- \qmlproperty real QtAudioEngine1::PlayVariation::minGain
+ \qmlproperty real QtAudioEngine::PlayVariation::minGain
This property specifies the minimum gain adjustment that can be applied in any playback.
*/
}
/*!
- \qmlproperty real QtAudioEngine1::PlayVariation::maxPitch
+ \qmlproperty real QtAudioEngine::PlayVariation::maxPitch
This property specifies the maximum pitch adjustment that can be applied in any playback.
*/
}
/*!
- \qmlproperty real QtAudioEngine1::PlayVariation::minPitch
+ \qmlproperty real QtAudioEngine::PlayVariation::minPitch
This property specifies the minimum pitch adjustment that can be applied in any playback.
*/
This type is part of the \b{QtAudioEngine 1.0} module.
- Sound can be accessed through QtAudioEngine1::AudioEngine::sounds with its unique name
+ Sound can be accessed through QtAudioEngine::AudioEngine::sounds with its unique name
and must be defined inside AudioEngine.
\qml
}
/*!
- \qmlproperty enumeration QtAudioEngine1::Sound::playType
+ \qmlproperty enumeration QtAudioEngine::Sound::playType
This property holds the playType. It can be one of:
}
/*!
- \qmlproperty string QtAudioEngine1::Sound::category
+ \qmlproperty string QtAudioEngine::Sound::category
This property specifies which AudioCategory this sound belongs to.
*/
}
/*!
- \qmlproperty string QtAudioEngine1::Sound::name
+ \qmlproperty string QtAudioEngine::Sound::name
This property holds the name of Sound, must be unique among all sounds and only
defined once.
}
/*!
- \qmlproperty string QtAudioEngine1::Sound::attenuationModel
+ \qmlproperty string QtAudioEngine::Sound::attenuationModel
This property specifies which attenuation model this sound will apply.
*/
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play()
+ \qmlmethod QtAudioEngine::Sound::play()
Creates a new \l SoundInstance and starts playing.
Position, direction and velocity are all set to \c "0,0,0".
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(gain)
+ \qmlmethod QtAudioEngine::Sound::play(gain)
Creates a new SoundInstance and starts playing with the adjusted \a gain.
Position, direction and velocity are all set to \c "0,0,0".
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(gain, pitch)
+ \qmlmethod QtAudioEngine::Sound::play(gain, pitch)
Creates a new SoundInstance and starts playing with the adjusted \a gain and \a pitch.
Position, direction and velocity are all set to \c "0,0,0".
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(position)
+ \qmlmethod QtAudioEngine::Sound::play(position)
Creates a new SoundInstance and starts playing with specified \a position.
Direction and velocity are all set to \c "0,0,0".
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(position, velocity)
+ \qmlmethod QtAudioEngine::Sound::play(position, velocity)
Creates a new SoundInstance and starts playing with specified \a position and \a velocity.
Direction is set to \c "0,0,0".
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(position, velocity, direction)
+ \qmlmethod QtAudioEngine::Sound::play(position, velocity, direction)
Creates a new SoundInstance and starts playing with specified \a position, \a velocity and
\a direction.
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(position, gain)
+ \qmlmethod QtAudioEngine::Sound::play(position, gain)
Creates a new SoundInstance and starts playing with specified \a position and adjusted \a gain.
Direction and velocity are all set to \c "0,0,0".
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(position, velocity, gain)
+ \qmlmethod QtAudioEngine::Sound::play(position, velocity, gain)
Creates a new SoundInstance and starts playing with specified \a position, \a velocity and
adjusted \a gain.
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(position, velocity, direction, gain)
+ \qmlmethod QtAudioEngine::Sound::play(position, velocity, direction, gain)
Creates a new SoundInstance and starts playing with specified \a position, \a velocity,
\a direction and adjusted \a gain.
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(position, gain, pitch)
+ \qmlmethod QtAudioEngine::Sound::play(position, gain, pitch)
Creates a new SoundInstance and starts playing with specified \a position, adjusted \a gain and
\a pitch.
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(position, velocity, gain, pitch)
+ \qmlmethod QtAudioEngine::Sound::play(position, velocity, gain, pitch)
Creates a new SoundInstance and starts playing with specified \a position, \a velocity,
adjusted \a gain and \a pitch.
}
/*!
- \qmlmethod QtAudioEngine1::Sound::play(position, velocity, direction, gain, pitch)
+ \qmlmethod QtAudioEngine::Sound::play(position, velocity, direction, gain, pitch)
Creates a new SoundInstance and starts playing with specified \a position, \a velocity,
\a direction, adjusted \a gain and \a pitch.
}
/*!
- \qmlmethod QtAudioEngine1::SoundInstance QtAudioEngine1::Sound::newInstance()
+ \qmlmethod QtAudioEngine::SoundInstance QtAudioEngine::Sound::newInstance()
Returns a new \l SoundInstance.
*/
}
/*!
- \qmlproperty QtAudioEngine1::AudioEngine QtAudioEngine1::SoundInstance::engine
+ \qmlproperty QtAudioEngine::AudioEngine QtAudioEngine::SoundInstance::engine
This property holds the reference to AudioEngine, must be set only once.
*/
}
/*!
- \qmlproperty string QtAudioEngine1::SoundInstance::sound
+ \qmlproperty string QtAudioEngine::SoundInstance::sound
This property specifies which Sound this SoundInstance will use. Unlike some properties in
other types, this property can be changed dynamically.
}
/*!
- \qmlproperty enumeration QtAudioEngine1::SoundInstance::state
+ \qmlproperty enumeration QtAudioEngine::SoundInstance::state
This property holds the current playback state. It can be one of:
}
/*!
- \qmlmethod QtAudioEngine1::SoundInstance::play()
+ \qmlmethod QtAudioEngine::SoundInstance::play()
Starts playback.
*/
}
/*!
- \qmlmethod QtAudioEngine1::SoundInstance::play()
+ \qmlmethod QtAudioEngine::SoundInstance::play()
Stops current playback.
*/
}
/*!
- \qmlmethod QtAudioEngine1::SoundInstance::play()
+ \qmlmethod QtAudioEngine::SoundInstance::play()
Pauses current playback.
*/
}
/*!
- \qmlproperty vector3d QtAudioEngine1::SoundInstance::position
+ \qmlproperty vector3d QtAudioEngine::SoundInstance::position
This property holds the current 3d position.
*/
}
/*!
- \qmlproperty vector3d QtAudioEngine1::SoundInstance::direction
+ \qmlproperty vector3d QtAudioEngine::SoundInstance::direction
This property holds the current 3d direction.
*/
}
/*!
- \qmlproperty vector3d QtAudioEngine1::SoundInstance::velocity
+ \qmlproperty vector3d QtAudioEngine::SoundInstance::velocity
This property holds the current 3d velocity.
*/
}
/*!
- \qmlproperty vector3d QtAudioEngine1::SoundInstance::gain
+ \qmlproperty vector3d QtAudioEngine::SoundInstance::gain
This property holds the gain adjustment which will be used to modulate the audio output level
from this SoundInstance.
}
/*!
- \qmlproperty vector3d QtAudioEngine1::SoundInstance::pitch
+ \qmlproperty vector3d QtAudioEngine::SoundInstance::pitch
This property holds the pitch adjustment which will be used to modulate the audio pitch
from this SoundInstance.
}
/*!
- \qmlsignal QtAudioEngine1::SoundInstance::onStateChanged(state)
+ \qmlsignal QtAudioEngine::SoundInstance::onStateChanged(state)
This handler is called when \l state is changed
*/
/*!
- \qmlsignal QtAudioEngine1::SoundInstance::onPositionChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::onPositionChanged()
This handler is called when \l position is changed
*/
/*!
- \qmlsignal QtAudioEngine1::SoundInstance::onDirectionChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::onDirectionChanged()
This handler is called when \l direction is changed
*/
/*!
- \qmlsignal QtAudioEngine1::SoundInstance::onVelocityChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::onVelocityChanged()
This handler is called when \l velocity is changed
*/
/*!
- \qmlsignal QtAudioEngine1::SoundInstance::onGainChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::onGainChanged()
This handler is called when \l gain is changed
*/
/*!
- \qmlsignal QtAudioEngine1::SoundInstance::onPitchChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::onPitchChanged()
This handler is called when \l pitch is changed
*/
/*!
- \qmlsignal QtAudioEngine1::SoundInstance::onSoundChanged()
+ \qmlsignal QtAudioEngine::SoundInstance::onSoundChanged()
This handler is called when \l sound is changed
*/