Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
StreamUtils::AudioPreferences Struct Reference

The settings that decide which audio stream playback starts with. More...

#include <StreamUtils.h>

Static Public Member Functions

static AudioPreferences Current ()
 Read the settings as they currently stand.
 

Public Attributes

KODI::UTILS::CLanguageTag language
 The language wanted. Empty when the preference is not a language.
 
bool preferOriginal {false}
 The preference is "original language": prefer whichever stream is flagged original.
 
bool mediaDefault {false}
 The preference is "media default".
 
bool preferHearingImpaired {false}
 
bool preferVisualImpaired {false}
 
bool preferDefaultFlag {false}
 
bool preferStereo {false}
 Prefer a stereo stream. This follows from the audio output layout rather than a setting, so only the player can fill it in; the library leaves it false.
 

Detailed Description

The settings that decide which audio stream playback starts with.

Read once and reused for every comparison, so that a setting changed midway through cannot make a sort order inconsistent, and so a sort does not pay for a settings lookup per comparison.

Member Function Documentation

◆ Current()

StreamUtils::AudioPreferences StreamUtils::AudioPreferences::Current ( )
static

Read the settings as they currently stand.

Note
preferStereo is not a setting and is left false. The player sets it afterwards.

Member Data Documentation

◆ language

KODI::UTILS::CLanguageTag StreamUtils::AudioPreferences::language

The language wanted. Empty when the preference is not a language.

◆ mediaDefault

bool StreamUtils::AudioPreferences::mediaDefault {false}

The preference is "media default".

◆ preferDefaultFlag

bool StreamUtils::AudioPreferences::preferDefaultFlag {false}

◆ preferHearingImpaired

bool StreamUtils::AudioPreferences::preferHearingImpaired {false}

◆ preferOriginal

bool StreamUtils::AudioPreferences::preferOriginal {false}

The preference is "original language": prefer whichever stream is flagged original.

◆ preferStereo

bool StreamUtils::AudioPreferences::preferStereo {false}

Prefer a stereo stream. This follows from the audio output layout rather than a setting, so only the player can fill it in; the library leaves it false.

◆ preferVisualImpaired

bool StreamUtils::AudioPreferences::preferVisualImpaired {false}

The documentation for this struct was generated from the following files: