Qt Mobility Reference Documentation

QML Audio Element

The Audio element allows you to add audio playback to a scene. More...

Properties

Signals

Methods

Detailed Description

This element is part of the QtMultimediaKit 1.1 module.

 import Qt 4.7
 import QtMultimediaKit 1.1

 Text {
     text: "Click Me!";
     font.pointSize: 24;
     width: 150; height: 50;

     Audio {
         id: playMusic
         source: "music.wav"
     }
     MouseArea {
         id: playArea
         anchors.fill: parent
         onPressed:  { playMusic.play() }
     }
 }

See also Video.


Property Documentation

autoLoad : url

This property indicates if loading of media should begin immediately.

Defaults to true, if false media will not be loaded until playback is started.


bufferProgress : real

This property holds how much of the data buffer is currently filled, from 0.0 (empty) to 1.0 (full).


read-onlyduration : int

This property holds the duration of the media in milliseconds.

If the media doesn't have a fixed duration (a live stream for example) this will be 0.


read-onlyerror : enumeration

This property holds the error state of the audio. It can be one of:

  • NoError - there is no current error.
  • ResourceError - the audio cannot be played due to a problem allocating resources.
  • FormatError - the audio format is not supported.
  • NetworkError - the audio cannot be played due to network issues.
  • AccessDenied - the audio cannot be played due to insufficient permissions.
  • ServiceMissing - the audio cannot be played because the media service could not be instantiated.

read-onlyerrorString : string

This property holds a string describing the current error condition in more detail.


metaData.albumArtist : variant

This property holds the name of the principal artist of the album the media belongs to.

See also QtMultimediaKit::AlbumArtist.


metaData.albumTitle : variant

This property holds the title of the album the media belongs to.

See also QtMultimediaKit::AlbumTitle.


metaData.audioBitRate : variant

This property holds the bit rate of the media's audio stream ni bits per second.

See also QtMultimediaKit::AudioBitRate.


metaData.audioCodec : variant

This property holds the encoding of the media audio stream.

See also QtMultimediaKit::AudioCodec.


metaData.author : variant

This property holds the author of the media.

See also QtMultimediaKit::Author.


metaData.averageLevel : variant

This property holds the average volume level of the media.

See also QtMultimediaKit::AverageLevel.


metaData.category : variant

This property holds the category of the media

See also QtMultimediaKit::Category.


metaData.channelCount : variant

This property holds the number of channels in the media's audio stream.

See also QtMultimediaKit::ChannelCount.


metaData.chapterNumber : variant

This property holds the chapter number of the media.

See also QtMultimediaKit::ChapterNumber.


metaData.comment : variant

This property holds a user comment about the media.

See also QtMultimediaKit::Comment.


metaData.composer : variant

This property holds the composer of the media.

See also QtMultimediaKit::Composer.


metaData.conductor : variant

This property holds the conductor of the media.

See also QtMultimediaKit::Conductor.


metaData.contributingArtist : variant

This property holds the names of artists contributing to the media.

See also QtMultimediaKit::ContributingArtist.


metaData.copyright : variant

This property holds the media's copyright notice.

See also QtMultimediaKit::Copyright.


metaData.coverArtUrlLarge : variant

This property holds the URL of a large cover art image.

See also QtMultimediaKit::CoverArtUrlLarge.


metaData.coverArtUrlSmall : variant

This property holds the URL of a small cover art image.

See also QtMultimediaKit::CoverArtUrlSmall.


metaData.date : variant

This property holds the date of the media.

See also QtMultimediaKit::Date.


metaData.description : variant

This property holds a description of the media.

See also QtMultimediaKit::Description.


metaData.director : variant

This property holds the director of the media.

See also QtMultimediaKit::Director.


metaData.genre : variant

This property holds the genre of the media.

See also QtMultimediaKit::Genre.


metaData.keywords : variant

This property holds a list of keywords describing the media.

See also QtMultimediaKit::Keywords.


metaData.language : variant

This property holds the language of the media, as an ISO 639-2 code.

See also QtMultimediaKit::Language.


metaData.leadPerformer : variant

This property holds the lead performer in the media.

See also QtMultimediaKit::LeadPerformer.


metaData.lyrics : variant

This property holds the lyrics to the media.

See also QtMultimediaKit::Lyrics.


metaData.mediaType : variant

This property holds the type of the media.

See also QtMultimediaKit::MediaType.


metaData.mood : variant

This property holds the mood of the media.

See also QtMultimediaKit::Mood.


metaData.parentalRating : variant

This property holds the parental rating of the media.

See also QtMultimediaKit::ParentalRating.


metaData.peakValue : variant

This property holds the peak volume of media's audio stream.

See also QtMultimediaKit::PeakValue.


metaData.pixelAspectRatio : variant

This property holds the pixel aspect ratio of an image or video.

See also QtMultimediaKit::PixelAspectRatio.


metaData.posterUrl : variant

This property holds the URL of a poster image.

See also QtMultimediaKit::PosterUrl.


metaData.publisher : variant

This property holds the publisher of the media.

See also QtMultimediaKit::Publisher.


metaData.ratingOrganisation : variant

This property holds the name of the rating organisation responsible for the parental rating of the media.

See also QtMultimediaKit::RatingOrganisation.


metaData.resolution : variant

This property holds the dimension of an image or video.

See also QtMultimediaKit::Resolution.


metaData.sampleRate : variant

This property holds the sample rate of the media's audio stream in hertz.

See also QtMultimediaKit::SampleRate.


metaData.size : variant

This property property holds the size of the media in bytes.

See also QtMultimediaKit::Size.


metaData.subTitle : variant

This property holds the sub-title of the media.

See also QtMultimediaKit::SubTitle.


metaData.title : variant

This property holds the tile of the media.

See also QtMultimediaKit::Title.


metaData.trackCount : variant

This property holds the number of track on the album containing the media.

See also QtMultimediaKit::TrackNumber.


metaData.trackNumber : variant

This property holds the track number of the media.

See also QtMultimediaKit::TrackNumber.


metaData.userRating : variant

This property holds a user rating of the media in the range of 0 to 100.

See also QtMultimediaKit::UserRating.


metaData.videoBitRate : variant

This property holds the bit rate of the media's video stream in bits per second.

See also QtMultimediaKit::VideoBitRate.


metaData.videoCodec : variant

This property holds the encoding of the media's video stream.

See also QtMultimediaKit::VideoCodec.


metaData.videoFrameRate : variant

This property holds the frame rate of the media's video stream.

See also QtMultimediaKit::VideoFrameRate.


metaData.writer : variant

This property holds the writer of the media.

See also QtMultimediaKit::Writer.


metaData.year : variant

This property holds the year of release of the media.

See also QtMultimediaKit::Year.


muted : bool

This property holds whether the audio output is muted.


paused : bool

This property holds whether the media is paused.

Defaults to false, and can be set to true to pause playback.


playbackRate : real

This property holds the rate at which audio is played at as a multiple of the normal rate.


playing : bool

This property holds whether the media is playing.

Defaults to false, and can be set to true to start playback.


position : int

This property holds the current playback position in milliseconds.

If the seekable property is true, this property can be set to seek to a new position.


read-onlyseekable : bool

This property holds whether position of the audio can be changed.

If true; setting a position value will cause playback to seek to the new position.


source : url

This property holds the source URL of the media.


read-onlystatus : enumeration

This property holds the status of media loading. It can be one of:

  • NoMedia - no media has been set.
  • Loading - the media is currently being loaded.
  • Loaded - the media has been loaded.
  • Buffering - the media is buffering data.
  • Stalled - playback has been interrupted while the media is buffering data.
  • Buffered - the media has buffered data.
  • EndOfMedia - the media has played to the end.
  • InvalidMedia - the media cannot be played.
  • UnknownStatus - the status of the media is unknown.

volume : real

This property holds the volume of the audio output, from 0.0 (silent) to 1.0 (maximum volume).


Signal Documentation

Audio::onError ( error, errorString )

This handler is called when an error has occurred. The errorString parameter may contain more detailed information about the error.


Audio::onPaused ()

This handler is called when playback is paused.


Audio::onResumed ()

This handler is called when playback is resumed from the paused state.


Audio::onStarted ()

This handler is called when playback is started.


Audio::onStopped ()

This handler is called when playback is stopped.


Method Documentation

Audio::pause ()

Pauses playback of the media.

Sets the playing and paused properties to true.


Audio::play ()

Starts playback of the media.

Sets the playing property to true, and the paused property to false.


Audio::stop ()

Stops playback of the media.

Sets the playing and paused properties to false.


X

Thank you for giving your feedback.

Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.