SoundInstance QML Type

Play 3d audio content. More...

• List of all members, including inherited members

Properties

• direction : vector3d
• engine : QtAudioEngine::AudioEngine
• gain : vector3d
• pitch : vector3d
• position : vector3d
• sound : string
• state : enumeration
• velocity : vector3d

Signals

• directionChanged()
• gainChanged()
• pitchChanged()
• positionChanged()
• soundChanged()
• stateChanged(state)
• velocityChanged()

Methods

• pause()
• play()
• stop()

Detailed Description

There are two ways to create SoundInstance objects. You can obtain it by calling newInstance method of a Sound:

  Rectangle {
      id:root
      color:"white"
      width: 300
      height: 500

      AudioEngine {
          id:audioengine

          AudioSample {
              name:"explosion01"
              source: "explosion-01.wav"
          }

          Sound {
              name:"explosion"
              PlayVariation {
                  sample:"explosion01"
              }
          }
      }

      property variant soundEffect: audioengine.sounds["explosion"].newInstance();

      MouseArea {
          anchors.fill: parent
          onPressed: {
              root.soundEffect.play();
          }
      }
  }

Or alternatively, you can explicitly define SoundInstance outside of AudioEngine for easier qml bindings:

  Rectangle {
      id:root
      color:"white"
      width: 300
      height: 500

      AudioEngine {
          id:audioengine

          AudioSample {
              name:"explosion01"
              source: "explosion-01.wav"
          }

          Sound {
              name:"explosion"
              PlayVariation {
                  sample:"explosion01"
              }
          }
      }

      Item {
          id: animator
          x: 10 + observer.percent * 100
          y: 20 + observer.percent * 80
          property real percent: 0
          SequentialAnimation on percent {
              loops: Animation.Infinite
              running: true
              NumberAnimation {
              duration: 8000
              from: 0
              to: 1
              }

          }
      }

      SoundInstance {
          id:soundEffect
          engine:audioengine
          sound:"explosion"
          position:Qt.vector3d(animator.x, animator.y, 0);
      }

      MouseArea {
          anchors.fill: parent
          onPressed: {
              soundEffect.play();
          }
      }
  }

Property Documentation

Signal Documentation

Method Documentation