Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DELIA-65802 : Fix for method and parameter names for IUserSettings. #363

Open
wants to merge 1 commit into
base: R4_4
Choose a base branch
from
Open

DELIA-65802 : Fix for method and parameter names for IUserSettings. #363

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 33 additions & 27 deletions interfaces/IUserSettings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,73 +31,80 @@ struct EXTERNAL IUserSettings : virtual public Core::IUnknown {
struct EXTERNAL INotification : virtual public Core::IUnknown {
enum { ID = ID_USER_SETTINGS_NOTIFICATION };

// @alt OnAudioDescriptionChanged
// @brief The AudioDescription setting has changed.
// @param enabled: Enabled/Disabled.
virtual void OnAudioDescriptionChanged(const bool enabled) = 0;

// @alt OnPreferredAudioLanguagesChanged
// @brief The preferredLanguages setting has changed.
// @param preferredLanguages: PreferredLanguages.
virtual void OnPreferredAudioLanguagesChanged(const string& preferredLanguages) = 0;
virtual void OnPreferredAudioLanguagesChanged(const string& preferredLanguages /* @text preferredLanguages */) = 0;

// @alt OnPresentationLanguageChanged
// @brief The PresentationLanguages setting has changed.
// @param presentationLanguages: PresentationLanguages.
virtual void OnPresentationLanguageChanged(const string& presentationLanguages) = 0;
virtual void OnPresentationLanguageChanged(const string& presentationLanguages /* @text presentationLanguages */) = 0;

// @alt OnCaptionsChanged
// @brief The Captions setting has changed.
// @param enabled: Enabled/Disabled.
virtual void OnCaptionsChanged(const bool enabled) = 0;

// @alt OnPreferredCaptionsLanguagesChanged
// @brief The PreferredCaptionsLanguages setting has changed.
// @param preferredLanguages: PreferredLanguages.
virtual void OnPreferredCaptionsLanguagesChanged(const string& preferredLanguages) = 0;
virtual void OnPreferredCaptionsLanguagesChanged(const string& preferredLanguages /* @text preferredLanguages */) = 0;

// @alt OnPreferredClosedCaptionServiceChanged
// @brief The PreferredClosedCaptionService setting has changed.
// @param service: "CC[1-4]", "TEXT[1-4]", "SERVICE[1-64]".
virtual void OnPreferredClosedCaptionServiceChanged(const string& service) = 0;

// @alt OnPrivacyModeChanged
// @brief The PrivacyMode setting has changed.
// @param privacyMode: "SHARE", "DO_NOT_SHARE".
virtual void OnPrivacyModeChanged(const string& privacyMode) = 0;
virtual void OnPrivacyModeChanged(const string& privacyMode /* @text privacyMode */) = 0;
};

virtual uint32_t Register(Exchange::IUserSettings::INotification* notification /* @in */) = 0;
virtual uint32_t Unregister(Exchange::IUserSettings::INotification* notification /* @in */) = 0;

// @property
// @alt SetAudioDescription
// @brief Sets AudioDescription ON/OFF. Players should preferred Audio Descriptive tracks over normal audio track when enabled
// @param enabled: Enabled/Disabled
virtual uint32_t SetAudioDescription(const bool enabled /* @in */) = 0;

// @property
// @alt GetAudioDescription
// @brief Gets the current AudioDescription setting
// @param enabled: Enabled/Disabled
virtual uint32_t GetAudioDescription(bool &enabled /* @out */) const = 0;

// @property
// @alt SetPreferredAudioLanguages
// @brief A prioritized list of ISO 639-2/B codes for the preferred audio languages,
// expressed as a comma separated lists of languages of zero of more elements.
// The players will pick the audio track that has the best match compared with
// this list. In the absence of a matching track, the player should by best
// effort select the preferred audio track.*/
// @param preferredLanguages: PreferredLanguages
virtual uint32_t SetPreferredAudioLanguages(const string& preferredLanguages /* @in */) = 0;
virtual uint32_t SetPreferredAudioLanguages(const string& preferredLanguages /* @in @text preferredLanguages */) = 0;

// @property
// @alt GetPreferredAudioLanguages
// @brief Gets the current PreferredAudioLanguages setting
// @param preferredLanguages: PreferredLanguages
virtual uint32_t GetPreferredAudioLanguages(string &preferredLanguages /* @out */) const = 0;
virtual uint32_t GetPreferredAudioLanguages(string &preferredLanguages /* @out @text preferredLanguages */) const = 0;

// @property
// @alt SetPresentationLanguage
// @brief Sets the presentationLanguages in a full BCP 47 value, including script, region, variant
// @param presentationLanguages: "en-US", "es-US", "en-CA", "fr-CA"
virtual uint32_t SetPresentationLanguage(const string& presentationLanguages /* @in */) = 0;
virtual uint32_t SetPresentationLanguage(const string& presentationLanguages /* @in @text presentationLanguages */) = 0;

// @property
// @alt GetPresentationLanguage
// @brief Gets the presentationLanguages
// @param presentationLanguages: "en-US", "es-US", "en-CA", "fr-CA"
virtual uint32_t GetPresentationLanguage(string &presentationLanguages /* @out */) const = 0;
virtual uint32_t GetPresentationLanguage(string &presentationLanguages /* @out @text presentationLanguages */) const = 0;

// @property
// @alt SetCaptions
// @brief brief Sets Captions ON/OFF.
// @details A setting of ON indicates that Players should select a subtitle track for presentation
// The Setting does not influence any running sessions. It is up to the player to enforce the setting.
Expand All @@ -111,50 +118,49 @@ struct EXTERNAL IUserSettings : virtual public Core::IUnknown {
// @param enabled Sets the state
virtual uint32_t SetCaptions(const bool enabled /* @in */) = 0;

// @property
// @alt GetCaptions
// @brief Gets the Captions setting.
// @param enabled Receives the state
virtual uint32_t GetCaptions(bool &enabled /* @out */) const = 0;

// @property
// @alt SetPreferredCaptionsLanguages
// @brief Set preferred languages for captions.
// @details A prioritized list of ISO 639-2/B codes for the preferred Captions languages,
// expressed as a comma separated lists of languages of zero of more elements.
// The players will pick the subtitle track that has the best match compared with
// this list. In the absence of a matching track, the player should by best
// effort select the preferred subtitle track.
// @param preferredLanguages Is the list to set (e.g. "eng,fra")
virtual uint32_t SetPreferredCaptionsLanguages(const string& preferredLanguages /* @in */) = 0;
virtual uint32_t SetPreferredCaptionsLanguages(const string& preferredLanguages /* @in @text preferredLanguages */) = 0;

// @property
// @alt GetPreferredCaptionsLanguages
// @brief Gets the current PreferredCaptionsLanguages setting.
// @param preferredLanguages (e.g. "eng,fra")
virtual uint32_t GetPreferredCaptionsLanguages(string &preferredLanguages /* @out */) const = 0;
virtual uint32_t GetPreferredCaptionsLanguages(string &preferredLanguages /* @out @text preferredLanguages */) const = 0;

// @property
// @alt SetPreferredClosedCaptionService
// @brief Sets the PreferredClosedCaptionService.
// @details The setting should be honored by the player. The behaviour of AUTO may be player specific.
// Valid input for service is "CC[1-4]", "TEXT[1-4]", "SERVICE[1-64]"
// @param service Identifies the service to display e.g. "CC3".

virtual uint32_t SetPreferredClosedCaptionService(const string& service /* @in */) = 0;

// @property
// @alt GetPreferredClosedCaptionService
// @brief Gets the current PreferredClosedCaptionService setting.
// @param service Identifies the service to display e.g. "CC3".
virtual uint32_t GetPreferredClosedCaptionService(string &service /* @out */) const = 0;

// @property
// @alt SetPrivacyMode
// @brief Sets the PrivacyMode.
// @details The setting should be honored by the Telemetry.
// If privacyMode is "DO_NOT_SHARE", logs and crash report should not be uploaded.
// @param privacyMode: "SHARE", "DO_NOT_SHARE"
virtual uint32_t SetPrivacyMode(const string& privacyMode /* @in */) = 0;
virtual uint32_t SetPrivacyMode(const string& privacyMode /* @in @text privacyMode*/) = 0;

// @property
// @alt GetPrivacyMode
// @brief Gets the current PrivacyMode setting.
// @param privacyMode e.g "SHARE"
virtual uint32_t GetPrivacyMode(string &privacyMode /* @out */) const = 0;
virtual uint32_t GetPrivacyMode(string &privacyMode /* @out @text privacyMode */) const = 0;
};
} // namespace Exchange
} // namespace WPEFramework