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

RDK-48604: New UserSettings Thunder Plugin #374

Open
wants to merge 3 commits into
base: R4_4
Choose a base branch
from
+162 −41
Open

RDK-48604: New UserSettings Thunder Plugin #374

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dd1e712
RDK-48604: New UserSettings Thunder Plugin
Dosakaya Aug 29, 2024
55a78b2
RDK-48604: New UserSettings Thunder Plugin
Dosakaya Sep 6, 2024
2cf736d
Replacing @alt tag with @text tag
Dosakaya Sep 6, 2024
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
203 changes: 162 additions & 41 deletions interfaces/IUserSettings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,81 +23,124 @@

namespace WPEFramework {
namespace Exchange {
// @json
struct EXTERNAL IUserSettings : virtual public Core::IUnknown {
// @json @text:keep
struct EXTERNAL IUserSettings : virtual public Core::IUnknown {
enum { ID = ID_USER_SETTINGS };

// @event
struct EXTERNAL INotification : virtual public Core::IUnknown {
enum { ID = ID_USER_SETTINGS_NOTIFICATION };

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

// @text 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;

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

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

// @text 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;

// @text 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;

// @text 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;

// @text onPinControlChanged
// @brief The PinControl setting has changed.
// @param enabled: Enabled/Disabled.
virtual void OnPinControlChanged(const bool enabled) = 0;

// @text onViewingRestrictionsChanged
// @brief The ViewingRestrictions setting has changed.
// @param viewingRestrictions: Empty string
virtual void OnViewingRestrictionsChanged(const string& viewingRestrictions /* @text viewingRestrictions */) = 0;

// @text onViewingRestrictionsWindowChanged
// @brief The ViewingRestrictionsWindow setting has changed.
// @param viewingRestrictionsWindow: "ALWAYS"
virtual void OnViewingRestrictionsWindowChanged(const string& viewingRestrictionsWindow /* @text viewingRestrictionsWindow */) = 0;

// @text onLiveWatershedChanged
// @brief The LiveWatershed setting has changed.
// @param enabled: Enabled/Disabled.
virtual void onLiveWatershedChanged(const bool enabled) = 0;

// @text onPlaybackWatershedChanged
// @brief The PlaybackWatershed setting has changed.
// @param enabled: Enabled/Disabled.
virtual void OnPlaybackWatershedChanged(const bool enabled) = 0;

// @text onBlockNotRatedContentChanged
// @brief The BlockNotRatedContent setting has changed.
// @param enabled: Enabled/Disabled.
virtual void OnBlockNotRatedContentChanged(const bool enabled) = 0;

// @text onPinOnPurchaseChanged
// @brief The PinOnPurchase setting has changed.
// @param enabled: Enabled/Disabled.
virtual void OnPinOnPurchaseChanged(const bool enabled) = 0;

};

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

// @property
// @text 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
// @text getAudioDescription
// @brief Gets the current AudioDescription setting
// @param enabled: Enabled/Disabled
virtual uint32_t GetAudioDescription(bool &enabled /* @out */) const = 0;

// @property
// @text 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
// @text 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
// @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;
// @text setPresentationLanguage
// @brief Sets the presentationLanguage in a full BCP 47 value, including script, region, variant
// @param presentationLanguage: "en-US", "es-US", "en-CA", "fr-CA"
virtual uint32_t SetPresentationLanguage(const string& presentationLanguage /* @in @text presentationLanguage */) = 0;

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

// @property
// @text 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 @@ -108,53 +151,131 @@ struct EXTERNAL IUserSettings : virtual public Core::IUnknown {
// When media players start playback, they should also call the GetCaptions method to retrieve the current enabled state.
// This holds true for media players that utilize TextTrack render sessions for text track decode-display and also for media
// players or apps that decode-display internally
// @param enabled Sets the state
// @param enabled: Sets the state
virtual uint32_t SetCaptions(const bool enabled /* @in */) = 0;

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

// @property
// @text 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;
// @param preferredLanguages: Is the list to set (e.g. "eng,fra")
virtual uint32_t SetPreferredCaptionsLanguages(const string& preferredLanguages /* @in @text preferredLanguages */) = 0;

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

// @property
// @text 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".

// @param service: Identifies the service to display e.g. "CC3".
virtual uint32_t SetPreferredClosedCaptionService(const string& service /* @in */) = 0;

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

// @property
// @text 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
// @text getPrivacyMode
// @brief Gets the current PrivacyMode setting.
// @param privacyMode e.g "SHARE"
virtual uint32_t GetPrivacyMode(string &privacyMode /* @out */) const = 0;
// @param privacyMode: "SHARE"
virtual uint32_t GetPrivacyMode(string &privacyMode /* @out @text privacyMode */) const = 0;

// @text setPinControl
// @brief Sets PinControl ON/OFF. Parental Control as a whole is enabled or disabled.
// @param enabled: Enabled/Disabled
virtual uint32_t SetPinControl(const bool enabled /* @in */) = 0;

// @text getPinControl
// @brief Gets the PinControl setting
// @param enabled: Enabled/Disabled
virtual uint32_t GetPinControl(bool &enabled /* @out */) const = 0;

// @text setViewingRestrictions
// @brief Sets the ViewingRestrictions.
// @details A JSON document that escribes the rating scheme(s) and ratings that are blocked.
// @param viewingRestrictions: A JSON document that describes the rating scheme(s) and ratings that are blocked.
virtual uint32_t SetViewingRestrictions(const string& viewingRestrictions /* @in @text viewingRestrictions */) = 0;

// @text getViewingRestrictions
// @brief Gets the current ViewingRestrictions.
// @param viewingRestrictions: A JSON document that escribes the rating scheme(s) and ratings that are blocked.
virtual uint32_t GetViewingRestrictions(string &viewingRestrictions /* @out @text viewingRestrictions */) const = 0;

// @text setViewingRestrictionsWindow
// @brief Sets the ViewingRestrictionsWindow.
// @details A project-specific representation of the time interval when viewing
// restrictions are to be applied, if applicable for the project
// @param viewingRestrictionsWindow: A project-specific representation of the time interval.Eg: "ALWAYS"
virtual uint32_t SetViewingRestrictionsWindow(const string &viewingRestrictionsWindow /* @in @text viewingRestrictionsWindow */) = 0;

// @text getViewingRestrictionsWindow
// @brief Gets the current ViewingRestrictionsWindow.
// @param viewingRestrictionsWindow: A project-specific representation of the time interval.Eg: "ALWAYS"
virtual uint32_t GetViewingRestrictionsWindow(string &viewingRestrictionsWindow /* @out @text viewingRestrictionsWindow */) const = 0;

// @text setLiveWatershed
// @brief Sets LiveWatershed ON/OFF.Whether project-specific watershed rules
// should be applied for live content, if applicable for the project.
// @param enabled: Enabled/Disabled
virtual uint32_t SetLiveWatershed(const bool enabled /* @in */) = 0;

// @text getLiveWatershed
// @brief Gets the LiveWatershed setting
// @param enabled: Enabled/Disabled
virtual uint32_t GetLiveWatershed(bool &enabled /* @out */) const = 0;

// @text setPlaybackWatershed
// @brief Sets PlaybackWatershed ON/OFF. Whether project-specific watershed rules
// should be applied for non-live content, if applicable for the project.
// @param enabled: Enabled/Disabled
virtual uint32_t SetPlaybackWatershed(const bool enabled /* @in */) = 0;

// @text getPlaybackWatershed
// @brief Gets the PlaybackWatershed setting
// @param enabled: Enabled/Disabled
virtual uint32_t GetPlaybackWatershed(bool &enabled /* @out */) const = 0;

// @text setBlockNotRatedContent
// @brief Sets BlockNotRatedContent ON/OFF. Whether content that is not rated should be
// blocked, if applicable for the project.
// @param enabled: Enabled/Disabled
virtual uint32_t SetBlockNotRatedContent(const bool enabled /* @in */) = 0;

// @text getBlockNotRatedContent
// @brief Gets the BlockNotRatedContent setting
// @param enabled: Enabled/Disabled
virtual uint32_t GetBlockNotRatedContent(bool &enabled /* @out */) const = 0;

// @text setPinOnPurchase
// @brief Sets PinOnPurchase ON/OFF.Whether a PIN challenge should be made
// when a purchase is attempted.
// @param enabled: Enabled/Disabled
virtual uint32_t SetPinOnPurchase(const bool enabled /* @in */) = 0;

// @text getPinOnPurchase
// @brief Gets the PinOnPurchase setting
// @param enabled: Enabled/Disabled
virtual uint32_t GetPinOnPurchase(bool &enabled /* @out */) const = 0;

};
} // namespace Exchange
} // namespace WPEFramework