Multimedia Namespace

QtOhosExtras::Multimedia

Provides multimedia utility functions for HarmonyOS. More...

Header:	#include <Multimedia>
qmake:	QT += ohosextras
Since:	Qt 5.12.12

This namespace was introduced in Qt 5.12.12.

Types

enum class	AudioStreamUsageHint { Unknown, Music, VoiceCommunication, VoiceAssistant, Alarm, …, VideoCommunication }

Functions

void	setAudioStreamUsageHintProperty(QObject *soundEffectOrSound, AudioStreamUsageHint usageHint)
bool	tryGetAudioStreamUsageHintProperty(QObject *soundEffectOrSound, AudioStreamUsageHint *usageHint)

Detailed Description

The Multimedia namespace contains functions and types for controlling audio stream usage on HarmonyOS. It allows setting audio stream usage hints on QSoundEffect and QSound objects, which influences how the system routes and manages audio output.

Type Documentation

enum class Multimedia::AudioStreamUsageHint

Describes the intended usage of an audio stream. The system uses this hint to apply appropriate audio policies such as volume control, audio focus, and routing.

Constant	Value	Description
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Unknown`	`0`	The audio stream usage is not specified.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Music`	`1`	Used for music playback.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::VoiceCommunication`	`2`	Used for voice calls or VoIP.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::VoiceAssistant`	`3`	Used for voice assistant interactions.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Alarm`	`4`	Used for alarm sounds.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::VoiceMessage`	`5`	Used for voice message playback.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Ringtone`	`6`	Used for incoming call ringtones.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Notification`	`7`	Used for notification sounds.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Accessibility`	`8`	Used for accessibility-related audio.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Movie`	`9`	Used for movie or video playback audio.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Game`	`10`	Used for game audio.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Audiobook`	`11`	Used for audiobook playback.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::Navigation`	`12`	Used for navigation prompts.
`QtOhosExtras::Multimedia::AudioStreamUsageHint::VideoCommunication`	`13`	Used for video call audio.

This enum was introduced or modified in Qt 5.12.12.

Function Documentation

void Multimedia::setAudioStreamUsageHintProperty(QObject **soundEffectOrSound, AudioStreamUsageHint usageHint*)

Sets the audio stream usageHint on the given soundEffectOrSound object.

The soundEffectOrSound must be an instance of QSoundEffect or QSound. If the object is not a supported type, an error is logged and the function returns without modifying the object.

 QSoundEffect effect;
 effect.setSource(QUrl::fromLocalFile("notification.wav"));
 QtOhosExtras::Multimedia::setAudioStreamUsageHintProperty(
     &effect, QtOhosExtras::Multimedia::AudioStreamUsageHint::Notification);
 effect.play();

See also tryGetAudioStreamUsageHintProperty().

bool Multimedia::tryGetAudioStreamUsageHintProperty(QObject **soundEffectOrSound*, AudioStreamUsageHint **usageHint*)

Attempts to retrieve the audio stream usage hint from the given soundEffectOrSound object and stores the result in usageHint.

Returns true if the usage hint was successfully retrieved, or false if the property is not set or the object does not support it.

See also setAudioStreamUsageHintProperty().