| commit 22c2c8f8963c432d2f7ebeb12ae4e91c6cfbb6b7 |
| Author: Siva Thandayuthapani <sithanda@synamedia.com> |
| Date: Thu Jun 6 17:32:17 2024 +0530 |
| |
| RDK-48604: New UserSettings Thunder Plugin |
| |
| diff -uprN a/interfaces/IUserSettings.h b/interfaces/IUserSettings.h |
| --- a/interfaces/IUserSettings.h 1970-01-01 03:00:00.000000000 +0300 |
| +++ b/interfaces/IUserSettings.h 2024-07-12 22:10:05.921196986 +0300 |
| @@ -0,0 +1,166 @@ |
| +/* |
| + * If not stated otherwise in this file or this component's LICENSE file the |
| + * following copyright and licenses apply: |
| + * |
| + * Copyright 2024 RDK Management |
| + * |
| + * Licensed under the Apache License, Version 2.0 (the "License"); |
| + * you may not use this file except in compliance with the License. |
| + * You may obtain a copy of the License at |
| + * |
| + * http://www.apache.org/licenses/LICENSE-2.0 |
| + * |
| + * Unless required by applicable law or agreed to in writing, software |
| + * distributed under the License is distributed on an "AS IS" BASIS, |
| + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| + * See the License for the specific language governing permissions and |
| + * limitations under the License. |
| + */ |
| + |
| +#pragma once |
| + |
| +#include "Module.h" |
| + |
| +namespace WPEFramework { |
| +namespace Exchange { |
| + // @json |
| +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 }; |
| + |
| + // @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 /* @text preferredLanguages */) = 0; |
| + |
| + // @alt OnPresentationLanguageChanged |
| + // @brief The PresentationLanguages setting has changed. |
| + // @param presentationLanguages: PresentationLanguages. |
| + 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 /* @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 /* @text privacyMode */) = 0; |
| + }; |
| + |
| + virtual uint32_t Register(Exchange::IUserSettings::INotification* notification /* @in */) = 0; |
| + virtual uint32_t Unregister(Exchange::IUserSettings::INotification* notification /* @in */) = 0; |
| + |
| + // @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; |
| + |
| + // @alt GetAudioDescription |
| + // @brief Gets the current AudioDescription setting |
| + // @param enabled: Enabled/Disabled |
| + virtual uint32_t GetAudioDescription(bool &enabled /* @out */) const = 0; |
| + |
| + // @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 @text preferredLanguages */) = 0; |
| + |
| + // @alt GetPreferredAudioLanguages |
| + // @brief Gets the current PreferredAudioLanguages setting |
| + // @param preferredLanguages: PreferredLanguages |
| + virtual uint32_t GetPreferredAudioLanguages(string &preferredLanguages /* @out @text preferredLanguages */) const = 0; |
| + |
| + // @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 @text presentationLanguages */) = 0; |
| + |
| + // @alt GetPresentationLanguage |
| + // @brief Gets the presentationLanguages |
| + // @param presentationLanguages: "en-US", "es-US", "en-CA", "fr-CA" |
| + virtual uint32_t GetPresentationLanguage(string &presentationLanguages /* @out @text presentationLanguages */) const = 0; |
| + |
| + // @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. |
| + // This is a global state persisted by the TextTrack plug-in applying to all forms of text; closed captions, Captions |
| + // and timed text types. |
| + // Media players should to listen to OnCaptionsChanged notifications to react to platform wide dynamic state changes |
| + // of this state while a playback is active. |
| + // 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 |
| + virtual uint32_t SetCaptions(const bool enabled /* @in */) = 0; |
| + |
| + // @alt GetCaptions |
| + // @brief Gets the Captions setting. |
| + // @param enabled Receives the state |
| + virtual uint32_t GetCaptions(bool &enabled /* @out */) const = 0; |
| + |
| + // @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 @text preferredLanguages */) = 0; |
| + |
| + // @alt GetPreferredCaptionsLanguages |
| + // @brief Gets the current PreferredCaptionsLanguages setting. |
| + // @param preferredLanguages (e.g. "eng,fra") |
| + virtual uint32_t GetPreferredCaptionsLanguages(string &preferredLanguages /* @out @text preferredLanguages */) const = 0; |
| + |
| + // @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; |
| + |
| + // @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; |
| + |
| + // @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 @text privacyMode*/) = 0; |
| + |
| + // @alt GetPrivacyMode |
| + // @brief Gets the current PrivacyMode setting. |
| + // @param privacyMode e.g "SHARE" |
| + virtual uint32_t GetPrivacyMode(string &privacyMode /* @out @text privacyMode */) const = 0; |
| +}; |
| +} // namespace Exchange |
| +} // namespace WPEFramework |
| diff --git a/interfaces/Ids.h b/interfaces/Ids.h |
| index 293b7ae..401ffd4 100644 |
| --- a/interfaces/Ids.h |
| +++ b/interfaces/Ids.h |
| @@ -371,8 +371,10 @@ namespace Exchange { |
| ID_AIRPLAYDAEMON = ID_AIRPLAY +2, |
| ID_AIRPLAYDAEMON_NOTIFICATION = ID_AIRPLAY +3, |
| ID_HOMEKITTV = ID_AIRPLAY +4, |
| - ID_HOMEKITTV_NOTIFICATION = ID_AIRPLAY +5 |
| + ID_HOMEKITTV_NOTIFICATION = ID_AIRPLAY +5, |
| |
| + ID_USER_SETTINGS = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x4F0, |
| + ID_USER_SETTINGS_NOTIFICATION = ID_USER_SETTINGS + 1 |
| }; |
| } |
| } |
