diff --git a/content/en/_index.html b/content/en/_index.html index d40d5e3a..31417a4d 100644 --- a/content/en/_index.html +++ b/content/en/_index.html @@ -5,7 +5,7 @@
News
- }}">webOS OSE 2.24.0 has been released! + }}">webOS OSE 2.25.0 has been released!
diff --git a/content/en/about/release-notes/webos-ose-2-25-0-release-notes.md b/content/en/about/release-notes/webos-ose-2-25-0-release-notes.md new file mode 100644 index 00000000..4b4ebf5e --- /dev/null +++ b/content/en/about/release-notes/webos-ose-2-25-0-release-notes.md @@ -0,0 +1,90 @@ +--- +title: webOS OSE 2.25.0 +display_title: webOS OSE 2.25.0 Release Notes +date: 2024-01-17 +weight: 44 +toc: true +layout: release-notes +--- + +This version corresponds to the [GitHub releases](https://github.com/webosose/build-webos/releases) from build #660 to build #685. + +## New and Changed Features + +- Update the copyright information. + +### Core Applications + +#### System UI + +- Home + - Fixed a bug that caused VKB missing when the user is trying to submit a feedback. + +#### System + +- Enact Browser + - Fixed a bug where VKB wasn't closed properly. + - Fixed a bug where the webview wasn't focused properly. + +#### Sample Apps + +- Camera + - Fixed a bug that caused duplicated resolutions in the dropdown menu. + +### Managers & Services + +#### App + +- Memory Mgr. + - Fixed a bug related to getMemoryStatus. + +#### Display + +- LSM + - Removed a revert for supporting QT_IM_MODULE. + - Fixed a bug where luna-send-pub was not working. + - Fixed a bug where the backspace key in VKB worked as the back key. + +#### Settings + +- configd + - Retired methods: `dump`, `fullDump`, `reloadConfigs`. + +#### External Device + +- PDM + - Fixed a bug that caused sound issues. + +### Base Components + +#### Display + +- Qt + - Upgraded Qt from v6.5.2 to v6.6.0. + +#### Media + +- g-media-pipeline + - Fixed a bug that caused frame drop issue in WebEx with HW decoding. +- PulseAudio + - Enabled to use multiple pre-processing effects for audio. + - Added a new audio feature: bass boost. + +#### i18n/l10n + +- iLib + - Upgraded loctool from v1.15.1 to [v1.15.4](https://github.com/iLib-js/ilib-loctool-webos-dist/releases/tag/v1.15.4). + - Upgraded iLib from v14.18.0 to [v14.19.0](https://github.com/iLib-js/iLib/releases/tag/v14.19.0). + +#### Web Engine + +- Blink + - Added the 'Reset Settings' feature. + - Added the 'Pinch-to-zoom' feature in the content area. + - Fixed a bug that caused an unresponsive popup to appear when a WebEx call was stopped. + - Fixed minor bugs in WebCodecs in Chromium v108. + - Change backend for WebRTC to VDA. + +## Known issues + +N/A \ No newline at end of file diff --git a/content/en/blog/posts/2024-01-17-webos-ose-2-25-0-release.md b/content/en/blog/posts/2024-01-17-webos-ose-2-25-0-release.md new file mode 100644 index 00000000..af0c91b8 --- /dev/null +++ b/content/en/blog/posts/2024-01-17-webos-ose-2-25-0-release.md @@ -0,0 +1,42 @@ +--- +title: webOS OSE 2.25.0 Release +date: 2024-01-17 +slug: webos-ose-2-25-0-release +posttype: release +toc: false +thumbnail: th-release-2-25-0-base-enhancement.png +--- + +We're pleased to announce the release of webOS Open Source Edition (OSE) 2.25.0. + +The highlights of this release are as follows: + +- [Improving Enact Browser UX](#improving-enact-browser-ux) +- [Enhancing Audio Environment](#enhancing-audio-environment) + - [Audio Pre-processing Effect Chain](#audio-pre-processing-effect-chain) + - [Bass Enhancement](#bass-enhancement) +- [Upgrading Qt](#upgrading-qt) + +For more details on this release, see the [release notes](/about/release-notes/webos-ose-2-25-0-release-notes). + +## Improving Enact Browser UX + +The user experience of a web browser is important because it directly affects how users interact with the internet and websites. In this release, we enhanced usability, performance, and efficiency of the browser. + +- Support 'pinch-to-zoom' feature in the content area of a webview on touch screen. +- Add the 'Reset to Default Settings' option in the "Settings" page. +- Support custom user agent per domain to fix loading issue from the web server. + +## Enhancing Audio Environment + +### Audio Pre-processing Effect Chain + +From this version, webOS OSE supports multiple audio processing simultaneously. Developers can apply multiple audio pre-processing algorithms (such as beamforming, Echo Cancellation Noise Reduction (ECNR)). + +### Bass Enhancement + +Base enhancement algorithms and APIs are supported to provide a better audio experience. See [com.webos.service.audio]({{< relref "com-webos-service-audio" >}}). + +## Upgrading Qt + +Qt has been upgraded from v6.5.2 to v6.6.0 to improve graphics performance and stability. For more details about Qt, see the [official blog post](https://www.qt.io/blog/qt-6.6-released). diff --git a/content/en/docs/guides/development/configuration-files/appinfo-json.md b/content/en/docs/guides/development/configuration-files/appinfo-json.md index f1892885..1a081285 100644 --- a/content/en/docs/guides/development/configuration-files/appinfo-json.md +++ b/content/en/docs/guides/development/configuration-files/appinfo-json.md @@ -1,11 +1,11 @@ --- title: appinfo.json -date: 2023-02-01 +date: 2024-01-17 weight: 10 toc: true --- -Apps are required to have metadata before they can be packaged. This metadata is stored in a file called `appinfo.json`. +`appinfo.json` contains various metadata of apps, such as an app ID and type. webOS device uses `appinfo.json` to identify the app, its icon, and other information that is needed to launch the app. `appinfo.json` is located in the app's root directory and contains a single JSON object. @@ -45,12 +45,22 @@ Here are little tips that might help you with JSON syntax: - Type: `String` - Required: `Yes` -App ID, e.g. "com.newco.app.myapp". Every app has a unique ID, formed from reverse DNS naming conventions. App Bar uses the ID to uniquely identify your application and displays it with the title. The application ID is unique, set once, and cannot be changed after publishing the application. +App ID -- Start the ID with the reverse domain of company/institution. (Recommended) -- For app developers, the ID cannot start with the following reverse domain names: com.palm, com.webos, com.lge, com.palmdts. We recommend that platform developers who implement built-in apps and services can only use those names. -- Finish the ID with subdomain app.app-name. (Recommended) -- The ID **must** consist only of lowercase letters (a-z), digits (0-9), minus signs, and periods. It must be at least two characters long and must start with an alphanumeric character. +Every app has a unique ID, in a form of reversed DNS naming conventions. (e.g., `com.domain.app`) Using this ID, the [App Bar]({{< relref "webos-ose-ui-guide#app-bar" >}}) idetifies your app and displays it with the title. Each app ID is unique, sets once, and cannot be changed after publishing the app. + +Here are naming rules for the app ID: + +- Use lowercase (`a`-`z`), number digits (`0`-`9`), minus sign (`-`), and period (`.`). + + {{< caution >}} + If you develop a JS service, do not use minus sign (`-`) in your app ID. It causes an unexpected error. + {{< /caution >}} + +- Must be at least two characters long. +- Start with an alphanumeric character. +- Don't start with the following names: `com.palm`, `com.webos`, `com.lge`, `com.palmdts`. Only the platform developers who implement built-in apps and services can use those names. +- (Optional) Start with the reverse domain of company/institution. ### title @@ -179,6 +189,77 @@ Indicates the minimum amount of memory in megabytes required to run the app. - Required: `No` Specifies the required [Access Control Group (ACG)]({{< relref "security-guide" >}}) names associated with the LS2 API methods used in the app. The ACG names associated with each method can be found in their respective [LS2 API Reference]({{< relref "ls2-api-index" >}}). + +### allowAudioCapture + +- Type: `Boolean` +- Requires: `No` + +Indicates whether to allow access to audio capture devices. + +Possible values are: + +- `true`: Allow audio capture. +- `false`: (default) Disallow audio capture. + +{{< note >}} +Note: Added in API level 28. +{{< /note >}} + +### allowVideoCapture + +- Type: `Boolean` +- Requires: `No` + +This indicates whether to allow access to video capture devices. + +Possible values are: + +- `true`: Allow video capture. +- `false`: (default) Disallow video capture. + +### locationHint + +- Type: `String` +- Requires: `No` + +This property allows a Wayland client to ask the compositor to place its shell surface (main window) at a specific position expressed as cardinal points. + +Possible values are: + +- `center` (default) +- `north` +- `west` +- `south` +- `east` +- `northwest` +- `northeast` +- `southwest` +- `southeast` + +### thirdPartyCookiesPolicy + +- Type: `String` +- Requires: `No` + +This indicates whether to allow third-party cookies or not. + +Possible values are: + +- `allow`: (default) Allow third-party cookies +- `deny`: Disallow third party cookies + +### useUnlimitedMediaPolicy + +- Type: `Boolean` +- Requires: `No` + +This indicates whether the strict media policy will be relaxed. + +Possible values are: + +- `true`: Relax the strict media policy. +- `false`: (default) The strict media policy applies ## Example diff --git a/content/en/docs/reference/ls2-api/com-webos-appinstallservice.html b/content/en/docs/reference/ls2-api/com-webos-appinstallservice.html index 1662165f..d2f20c6e 100644 --- a/content/en/docs/reference/ls2-api/com-webos-appinstallservice.html +++ b/content/en/docs/reference/ls2-api/com-webos-appinstallservice.html @@ -1,7 +1,7 @@ --- title: com.webos.appInstallService -date: 2023-10-31 -api_level: 27 +date: 2024-01-17 +api_level: 28 weight: 10 toc: true --- @@ -173,7 +173,7 @@

Subscription Returns

Number

The current installation status. 

-

See the statusValue parameter (in Subscription Return) of the install method for more information.

+

See the statusValue property (in Subscription Return) of the install method for more information.

@@ -345,7 +345,7 @@

Subscription Returns

Number

The current app removal status.

-

See the statusValue parameter (in Subscription Return) of the install method for more information.

+

See the statusValue property (in Subscription Return) of the remove method for more information.

@@ -524,7 +524,8 @@

Subscription Returns

Required Number -

The current installation status. Possible values are:

+

The current installation status.

+

Possible values are:

@@ -596,6 +587,31 @@

Subscription Returns

+

Error Codes Reference

+
+ + + + + + + + + + + + + +
+

Error Code

+ 		+

Error Text

+ 		+

Error Description

+
-2Varies +

For details, check "API Error Codes Reference" table.

+
+

Example

Example code

@@ -607,20 +623,10 @@

Example

       "subscribe":true 
}'

-

 

-

Example response for a successful call: 

+

Response: 

{ 
  "subscribed": true, 
  "returnValue": true 
- }  -

-

 

-

Example response for a failed call: 

-

{ 
-   "subscribed": false, 
-   "errorCode": -2, 
-   "returnValue": false, 
-   "errorText": "Missing required key is required but it is missing" 
}

@@ -755,6 +761,14 @@

Subscription Returns

Description

+ + details + Required + Object: details + +

Contains detailed information of the progress of app removal.

+ + id Required @@ -769,15 +783,55 @@

Subscription Returns

Number

The current app removal status.

-

See the statusValue parameter (in Subscription Return) of the install method for more information.

+ + + + +

Error Codes Reference

+
+ + + + + + + - - - + + @@ -788,27 +842,13 @@

Example

Example code

-

# luna-send -i -f luna://com.webos.appInstallService/remove '{
-     "id":"com.test.app.hello",
-     "subscribe":true
- }' -

-

 

-

Example response for a successful call: 

+

# luna-send -i -f luna://com.webos.appInstallService/remove '{"id":"com.test.app.hello","subscribe":true}'

+

Response: 

{ 
   "subscribed": true, 
    "returnValue": true 
}

-

 

-

Example response for a failed call: 

-

{
-     "subscribed": false,
-     "errorCode": -2,
-     "returnValue": false,
-     "errorText": "Missing required key is required but it is missing"
- } -

status

@@ -1074,6 +1114,23 @@

details

Client who calls the operation request.

+ + + + + + + + + + + +
+

Error Code

+ 		+

Error Text

+ 		+

Error Description

+
detailsRequiredObject: details-2Varies -

Contains detailed information of the progress of app removal.

+

For details, check "API Error Codes Reference" table.
errorCodeOptionalNumber +

The error code for the failed operation.

+

Note: Only appears during app installation.

+
reasonOptionalString +

Indicates the reason for the failure of the operation.

+
diff --git a/content/en/docs/reference/ls2-api/com-webos-service-applicationmanager.html b/content/en/docs/reference/ls2-api/com-webos-service-applicationmanager.html index 3f68a5fa..e8750781 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-applicationmanager.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-applicationmanager.html @@ -1,7 +1,7 @@ --- title: com.webos.service.applicationmanager -date: 2023-10-31 -api_level: 27 +date: 2024-01-15 +api_level: 28 weight: 90 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-service-audio.html b/content/en/docs/reference/ls2-api/com-webos-service-audio.html index 9da232a1..83ea3ada 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-audio.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-audio.html @@ -1,7 +1,7 @@ --- title: com.webos.service.audio -date: 2023-10-31 -api_level: 27 +date: 2024-01-17 +api_level: 28 weight: 100 toc: true --- @@ -462,7 +462,7 @@

Call Returns

audio - Required + Optional Object array: audio

Audio connection details.

@@ -721,6 +721,7 @@

Parameters

  • beamforming
  • dynamic compressor
  • equalizer
    • +
  • bass boost
    • @@ -888,6 +889,18 @@

    Example

    }

    +
    +

    Example: Check the status of the bass boost audio effect

    +
    +
    +

    # luna-send -f -n 1 luna://com.webos.service.audio/checkAudioEffectStatus '{"effectName":"bass boost"}'

    +

    Response:

    +

    {
    +     "returnValue" : true,
    +     "enabled": true
    + } +

    +

    getAudioEffectList

    @@ -931,6 +944,7 @@

    Call Returns

  • beamforming (not listed if none of the array microphones support beamforming)
  • dynamic compressor
  • equalizer
    • +
  • bass boost
    • @@ -1013,6 +1027,7 @@

    Example

            "beamforming",
            "dynamic compressor",
            "equalizer"
    +         "bass boost"
        ]
    }

    @@ -1237,6 +1252,10 @@

    Example

            {
                "name": "equalizer",
                "enabled": false
    +         }, 
    +         {
    +             "name": "bass boost",
    +             "enabled": false
            }
         ]

    @@ -1384,7 +1403,7 @@

    Call Returns

    Optional String -

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    +

    Indicates the reason for the failure of the operation.

    @@ -1410,7 +1429,7 @@

    Subscription Returns

    subscribed - Required + Optional Boolean

    Indicates if the input volume is subscribed to get the notifications.

    @@ -1419,7 +1438,6 @@

    Subscription Returns

  • true: Subscribed for notifications.
  • false: Not subscribed.
    • -

    Note: Always returns true.

    @@ -1433,12 +1451,12 @@

    Subscription Returns

  • true: Indicates that the operation was successful.
  • false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
    • -

    Note: Always returns value as true.

    +

     

    streamType - Required + Optional String

    Indicates the stream name of the input volume to be applied. Check "Parameters" section for list of possible values.

    @@ -1446,7 +1464,7 @@

    Subscription Returns

    volume - Required + Optional Number

    Returns the value of applied volume in case of success.

    @@ -1456,25 +1474,56 @@

    Subscription Returns

    +

    Error Codes Reference

    +
    + + + + + + + + + + + + + + + + + + + + + + + +
    +

    Error Code

    +     		+

    Error Text

    +     		+

    Error Description

    +
    1Could not validate json message against schema +

    Error occurs due to wrong json request.

    +
    15Audiod Internal Error +

    Internal error

    +
    17Audiod Unknown Stream +

    A wrong streamType is requested.

    +
    +

    Example

    Example scenario

    -

    # luna-send -n i -f luna://com.webos.service.audio/getInputVolume '{
    +

    # luna-send -i -f luna://com.webos.service.audio/getInputVolume '{
       "streamType":"default1",
       "subscribe":true
    }'

    Response:

    -

    {
    -    "subscribed":true,
    -    "volume":50,
    -    "streamType":"default1",
    -    "returnValue":true
    - } -

    -

    Subscription response:

    {
       "subscribed":true,
       "volume":100,
    @@ -1743,13 +1792,13 @@

    Parameters

    subscribe Optional - String + Boolean

    Subscribe for notifications on changes in the sound output device.

    Possible values are:

    @@ -2438,9 +2487,8 @@

    Parameters

    Possible values are:

    -

    Default: false

    @@ -2492,11 +2540,6 @@

    Call Returns

    Boolean

    Indicates if subscribed to get the notifications.

    -

    Possible values are:

    - @@ -2512,7 +2555,7 @@

    Call Returns

    Optional String -

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    +

    Indicates the reason for the failure of the operation.

    @@ -2550,30 +2593,19 @@

    Subscription Returns

    Boolean

    Indicates the status of the operation.

    -

    Possible values are:

    - subscribed - Required + Optional Boolean

    Indicates if subscribed to get the notifications.

    -

    Possible values are:

    - -

    Note: Always returns true

    streamObject - Required + Optional Object array: streamObject

    Indicates the list of active connections.

    @@ -2582,12 +2614,51 @@

    Subscription Returns

    +

    Error Codes Reference

    +
    + + + + + + + + + + + + + + + + + + + + + + + +
    +

    Error Code

    +     		+

    Error Text

    +     		+

    Error Description

    +
    1Could not validate json message against schema +

    Error occurs due to wrong json request.

    +
    15Audiod Internal Error +

    Internal error

    +
    17Audiod Unknown Stream +

    A wrong streamType is requested.

    +
    +

    Example

    With subscription

    -

    # luna-send -n i -f luna://com.webos.service.audio/getStreamStatus '{
    +

    # luna-send -i -f luna://com.webos.service.audio/getStreamStatus '{
       "streamType":"default1",
       "subscribe":true
    }' @@ -2602,23 +2673,6 @@

    Example

             "muteStatus":false,
             "sink":"sink",
             "streamType":"default1",
    -          "activeStatus":false
    -       }
    -    ],
    -    "subscribed":true,
    -    "returnValue":true
    - } -

    -

    Subscription response:

    -

    {
    -    "streamObject":[
    -       {
    -          "policyStatus":false,
    -          "source":"source",
    -          "inputVolume":100,
    -          "muteStatus":false,
    -          "sink":"sink",
    -          "streamType":"default2",
             "activeStatus":true
          }
       ],
    @@ -3323,7 +3377,7 @@

    Call Returns

    Optional String -

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    +

    Indicates the reason for the failure of the operation.

    @@ -3784,7 +3838,7 @@

    Call Returns

    Optional String -

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    +

    Indicates the reason for the failure of the operation. 

    @@ -3839,6 +3893,13 @@

    Error Codes Reference

    Internal error

    + + 19 + Invalid muteVolume Parameters requested + +

    Wrong parameters in request

    + + 20 sessionId Not in Range @@ -4241,7 +4302,7 @@

    Call Returns

    Optional String -

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    +

    Indicates the reason for the failure of the operation. 

    @@ -4442,7 +4503,7 @@

    Call Returns

    Optional String -

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    +

    Indicates the reason for the failure of the operation.

    @@ -4486,6 +4547,13 @@

    Error Codes Reference

    Internal error

    + + 19 + Invalid volumeDown Parameters requested + +

    Wrong parameters in request

    + + 20 sessionId Not in Range @@ -4653,7 +4721,7 @@

    Call Returns

    Optional String -

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    +

    Indicates the reason for the failure of the operation.

    @@ -5353,7 +5421,7 @@

    Parameters

    format - Required + Optional String

    Indicates the sample format to be set.

    @@ -5361,20 +5429,20 @@

    Parameters

    sampleRate - Required + Optional Number

    Indicates the sample rate to be set.

    Possible rates are:

    @@ -5382,14 +5450,14 @@

    Parameters

    channels - Required + Optional Number

    Indicates the number of audio channels to be used while playing the file.

    Possible values are:

    +

    Error Codes Reference

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    Error Code

    +     		+

    Error Text

    +     		+

    Error Description

    +
    1Could not validate json message against schema +

    Error occurs due to wrong json request.

    +
    19Invalid file format +

    Invaild file format  provided 

    +
    19Invalid virtual sink name +

    Invaild virtual sink name provided 

    +
    19Invalid sample format +

    Invaild sample format provided 

    +
    19Invalid channel count +

    Invaild channel count provided 

    +
    19Invalid sample rate +

    Invaild sample rate provided 

    +
    +

    Example

    Example code

    @@ -5644,6 +5772,7 @@

    Parameters

  • beamforming
  • dynamic compressor
  • equalizer
    • +
  • bass boost
    • @@ -5821,6 +5950,17 @@

    Example

    }

    +
    +

    Example: Enable bass boost effect

    +
    +
    +

    # luna-send -f -n 1 luna://com.webos.service.audio/setAudioEffect '{"effectName":"bass boost", "enabled":true}'

    +

    Response:

    +

    { 
    +     "returnValue" : true
    + } +

    +

    setAudioEqualizerBandLevel

    @@ -6259,7 +6399,53 @@

    Call Returns

    Optional String -

    Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

    +

    Indicates the reason for the failure of the operation.

    + + + + +
    +

    Error Codes Reference

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -6514,7 +6700,7 @@

    Call Returns

    Possible values are:

    @@ -6567,6 +6753,13 @@

    Error Codes Reference

    Invalid number of input parameters against defined schema of the method

    + + + + +
    +

    Error Code

    +     		+

    Error Text

    +     		+

    Error Description

    +
    1Could not validate json message against schema +

    Error occurs due to wrong json request.

    +
    3Volume Not in Range +

    Error occurs due to invalid volume level.

    +
    15Audiod Internal Error +

    Internal error

    +
    17Audiod Unknown Stream +

    A wrong streamType is requested.
    204Audiod Unknown soundOutput +

    Invalid sound output value given

    +
    @@ -7011,7 +7204,7 @@

    Call Returns

    soundOut - Required + Optional String

    Indicates the audio output device.

    @@ -7097,7 +7290,7 @@

    Parameters

    name - Optional + Required String

    Name of the system sound.

    @@ -7158,6 +7351,52 @@

    Call Returns

    +

    Error Codes Reference

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    Error Code

    +     		+

    Error Text

    +     		+

    Error Description

    +
    1Could not validate json message against schema +

    Error occurs due to wrong json request.

    +
    2Missing 'name' string parameter. +

    'name' parameter is missed.

    +
    3Invalid 'name' string parameter value or file not found +

    Invalid 'name' parameter is provided.

    +
    3Invalid 'sink' string parameter value or file not found. +

    Invalid 'sink' parameter is provided.

    +
    +

    Example

    Example code

    @@ -7216,32 +7455,6 @@

    Example

    Example scenario

    -
    -

    # luna-send -n 1 -f luna://com.webos.service.audio/systemsounds/playFeedback '{}'

    -

    Response:

    -

    {
    -     "errorCode": 2,
    -     "returnValue": false,
    -     "errorText": "Missing 'name' string parameter."
    - } -

    -
    -
    -

    Example scenario

    -
    -
    -

    # luna-send -n 1 -f luna://com.webos.service.audio/systemsounds/playFeedback '{"namex": "voicestart"}'

    -

    Response:

    -

    {
    -     "errorCode": 1,
    -     "returnValue": false,
    -     "errorText": "Could not validate json message against schema"
    - } -

    -
    -
    -

    Example scenario

    -

    # luna-send -n 1 -f luna://com.webos.service.audio/systemsounds/playFeedback '{"name": "shutter"}'

    Response:

    @@ -7250,19 +7463,6 @@

    Example

    }

    -
    -

    Example scenario

    -
    -
    -

    # luna-send -n 1 -f luna://com.webos.service.audio/systemsounds/playFeedback '{"name": "shutter_test"}'

    -

    Response:

    -

    {
    -     "errorCode": 3,
    -     "returnValue": false,
    -     "errorText": "Invalid 'name' string parameter value or file not found."
    - } -

    -

    udev/event

    @@ -7803,6 +8003,7 @@

    effectStatus

  • beamforming 
  • dynamic compressor
  • equalizer
    • +
  • bass boost
    • @@ -8074,23 +8275,16 @@

    API Error Codes Reference

    Invalid number of input parameters against defined schema of the method

    - - 1 - Not a valid json message - -

    Wrong JSON message format

    - - 3 - Volume limit reached + Invalid volume control

    AUDIOD_ERRORCODE_NOT_SUPPORT_VOLUME_CHANGE

    3 - Invalid volume control + Volume limit reached

    AUDIOD_ERRORCODE_NOT_SUPPORT_VOLUME_CHANGE

    @@ -8146,14 +8340,14 @@

    API Error Codes Reference

    22 - Connection not supported + Not supported

    AUDIOD_ERRORCODE_NOT_SUPPORTED

    22 - Soundout type not supported + Driver error

    AUDIOD_ERRORCODE_NOT_SUPPORTED

    @@ -8167,14 +8361,14 @@

    API Error Codes Reference

    22 - Driver error + Soundout type not supported

    AUDIOD_ERRORCODE_NOT_SUPPORTED

    22 - Not supported + Connection not supported

    AUDIOD_ERRORCODE_NOT_SUPPORTED

    diff --git a/content/en/docs/reference/ls2-api/com-webos-service-camera2.html b/content/en/docs/reference/ls2-api/com-webos-service-camera2.html index abce221c..a5d7bf75 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-camera2.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-camera2.html @@ -1,7 +1,7 @@ --- title: com.webos.service.camera2 -date: 2023-10-31 -api_level: 27 +date: 2024-01-15 +api_level: 28 weight: 120 toc: true --- @@ -159,12 +159,19 @@

    Error Codes Reference

    - 22, 39, 45 - errormessage469 + 22, 45 + Depends on error code

    Check details in the "API Error Codes Reference" table.

    + + 39 + Fail to write file + +

    There is a problem or failure in writing data to a file. It could occur due to various reasons such as insufficient permissions, lack of disk space, or hardware issues.

    + +
    @@ -2884,7 +2891,7 @@

    Error Codes Reference

    20, 32, 200 - errormessage448 + Depends on error code

    Check details in the "API Error Codes Reference" table.

    @@ -2971,7 +2978,6 @@

    Parameters

    String

    Indicates the location where the captured images are to be saved.

    -

    Note: The API returns an error (error code 45) if the path specified is read-only.

    @@ -3027,6 +3033,38 @@

    Call Returns

    +

    Error Codes Reference

    +
    + + + + + + + + + + + + + + + + + + +
    +

    Error Code

    +     		+

    Error Text

    +     		+

    Error Description

    +
    39Fail to write file +

    There is a problem or failure in writing data to a file. It could occur due to various reasons such as insufficient permissions, lack of disk space, or hardware issues.

    +
    45Cannot write at the specified location +

    Cannot write at the specified location.

    +
    +

    Example

    Example : Without specifying the location

    @@ -3247,7 +3285,7 @@

    Error Codes Reference

    20, 32, 106, 200 - errormessage411 + Depends on error code

    Check details in the "API Error Codes Reference" table.

    @@ -3416,7 +3454,7 @@

    Error Codes Reference

    13, 20, 32, 200 - errormessage457 + Depends on error code

    Check details in the "API Error Codes Reference" table.

    @@ -3648,7 +3686,7 @@

    Error Codes Reference

    13, 20, 32, 200 - errormessage436 + Depends on error code

    Check details in the "API Error Codes Reference" table.

    diff --git a/content/en/docs/reference/ls2-api/com-webos-service-config.html b/content/en/docs/reference/ls2-api/com-webos-service-config.html index a9f24328..59a7b674 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-config.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-config.html @@ -1,7 +1,7 @@ --- title: com.webos.service.config -date: 2023-10-31 -api_level: 27 +date: 2024-01-15 +api_level: 28 weight: 130 toc: true --- @@ -69,13 +69,13 @@

    Overview of the API

  • Define under "configs" category as array

    • {
    -     "configs" : [
    -         {
    -         "data": {
    -             "compositorGeometry" : "1920x1080+0+0r0"
    -         }
    +   "configs" : [
    +     {
    +       "data": {
    +         "compositorGeometry" : "1920x1080+0+0r0"
    +       }
        }
    -     ]
    +   ]
    }

    @@ -110,11 +110,12 @@

    Methods

    dump

    ACG: systemconfig.devutility
    -
    Deprecated
    +
    Retired
    • Added: API level 27
    • Deprecated: API level 27
      • +
    • Retired: API level 28

    Description

    @@ -212,11 +213,12 @@

    Example

    fullDump

    ACG: systemconfig.devutility
    -
    Deprecated
    +
    Retired
    • Added: API level 27
    • Deprecated: API level 27
      • +
    • Retired: API level 28

    Description

    @@ -402,7 +404,7 @@

    Example

    getConfigs

    -
    ACG: activity.query,-
    +
    ACG: systemconfig.query
    • Added: API level 11
      • @@ -690,11 +692,12 @@

      Example

      reloadConfigs

      ACG: systemconfig.devutility
      -
      Deprecated
      +
      Retired
      • Added: API level 27
      • Deprecated: API level 27
        • +
      • Retired: API level 28

      Description

      @@ -748,7 +751,7 @@

      Example

      setConfigs

      -
      ACG: activity.operation,-
      +
      ACG: systemconfig.management
      • Added: API level 11
        • diff --git a/content/en/docs/reference/ls2-api/com-webos-service-pdm.html b/content/en/docs/reference/ls2-api/com-webos-service-pdm.html index 7c167a6c..0953884f 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-pdm.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-pdm.html @@ -1,7 +1,7 @@ --- title: com.webos.service.pdm -date: 2023-10-31 -api_level: 27 +date: 2024-01-15 +api_level: 28 weight: 250 toc: true --- @@ -2001,6 +2001,46 @@

        audioDeviceList

      +

      deviceListInfo

      +
      +

      An array containing information about the currently connected device(s).

      +
      + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      storageDeviceListOptionalObject array: storageDeviceList +

      List of information about the storage devices that are currently connected.

      +
      nonStorageDeviceListOptionalObject array: nonStorageDeviceList +

      List of information about the non-storage devices that are currently connected.

      +
      +
      +

      deviceStatusList

      List of the storage and non-storage devices connected and their statuses.

      @@ -2045,6 +2085,30 @@

      deviceStatusList

      List of statuses of the drives in the device

      + + productName + Optional + String + +

      Name of the device product.

      + + + + usbPortNum + Optional + Number + +

      Port number where the sound device is connected, it gives -1 for internal devices.

      + + + + vendorName + Optional + String + +

      Name of the device vendor.

      + +
      diff --git a/content/en/docs/reference/ls2-api/com-webos-service-settings.html b/content/en/docs/reference/ls2-api/com-webos-service-settings.html index e33de9f3..7cf02bf0 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-settings.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-settings.html @@ -1,7 +1,7 @@ --- title: com.webos.service.settings -date: 2023-10-31 -api_level: 27 +date: 2024-01-15 +api_level: 28 weight: 290 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-service-systemservice.html b/content/en/docs/reference/ls2-api/com-webos-service-systemservice.html index 2dd29084..cf171143 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-systemservice.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-systemservice.html @@ -1,7 +1,7 @@ --- title: com.webos.service.systemservice -date: 2023-10-31 -api_level: 27 +date: 2024-01-17 +api_level: 28 weight: 310 toc: true --- @@ -735,7 +735,7 @@

      Example

    deviceInfo/query

    -
    ACG: arescli.interface,-
    +
    ACG: systemsettings.query
    • Added: API level 11
      • @@ -1474,7 +1474,7 @@

      Example

    osInfo/query

    -
    ACG: arescli.interface,-
    +
    ACG: systemsettings.query
    • Added: API level 11
      • @@ -1880,10 +1880,9 @@

      Error Codes Reference

    Example

    -

    Example code

    +

    Example : Copy the ringtone file (.mp3) to desired location, for example (/usr/palm/sounds/)

    -

    // Copy the ringtone file(.mp3) to desired location. For example, "/usr/palm/sounds/"

    # luna-send -n 1 -f luna://com.webos.service.systemservice/ringtone/addRingtone '{"filePath": "/usr/palm/sounds/ringtone.mp3" }'

    Response:

    {
    @@ -2157,7 +2156,7 @@

    Example

    softwareInfo/query

    -
    ACG: arescli.interface,-
    +
    ACG: software.query
    • Added: API level 15
      • @@ -4417,7 +4416,7 @@

      Example

    timezone/createTimeZoneFromEasData

    -
    ACG: time.management,systemsettings.management
    +
    ACG: time.management
    • Added: API level 11
      • @@ -6201,7 +6200,7 @@

      TimeZoneEasRule

      month - Required + Optional Number

      The month. Possible values are 1 - 12.

      @@ -6209,7 +6208,7 @@

      TimeZoneEasRule

      dayOfWeek - Required + Optional Number

      Day of week. Possible values are 0 - 6, where 0 is Sunday and 6 is Saturday.

      @@ -6217,7 +6216,7 @@

      TimeZoneEasRule

      week - Required + Optional Number

      Week of the month. Possible values are 1 - 5, where 1 is the 1st week and 5 is the last or 5th week of month.

      @@ -6225,7 +6224,7 @@

      TimeZoneEasRule

      hour - Required + Optional Number

      The hour. Possible values are 0 - 23.

      diff --git a/content/en/docs/reference/ls2-api/com-webos-service-wifi.html b/content/en/docs/reference/ls2-api/com-webos-service-wifi.html index 346e78cd..d5b7b72c 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-wifi.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-wifi.html @@ -1,7 +1,7 @@ --- title: com.webos.service.wifi -date: 2023-10-31 -api_level: 27 +date: 2024-01-17 +api_level: 28 weight: 360 toc: true --- @@ -450,7 +450,7 @@

      Parameters

      ssid Optional - string + String

      SSID of the desired network. Required for all connections except when using a known profile (profileId parameter is set).

      @@ -458,7 +458,7 @@

      Parameters

      wasCreatedWithJoinOther Optional - boolean + Boolean

      Indicates whether to connect to a hidden network. Possible values are: 

        @@ -521,7 +521,7 @@

        Call Returns

        returnValue Required - boolean + Boolean

        Indicates the status of operation. Possible values are:

          @@ -707,7 +707,7 @@

          Call Returns

          wpspin Required - string + String

          An 8 digit random WPS pin.

          @@ -838,7 +838,7 @@

          Parameters

          profileId Required - string + String

          ID of the profile to be deleted.

          @@ -867,7 +867,7 @@

          Call Returns

          returnValue Required - boolean + Boolean

          Indicates the status of operation. Possible values are:

            @@ -1232,7 +1232,7 @@

            Example

    getCountryCode

    -
    ACG: None
    +
    ACG: wifi.query
    • Added: API level 11
      • @@ -1585,7 +1585,7 @@

      Parameters

      profileId Required - string + String

      ID of the profile to be listed.

      @@ -1622,7 +1622,7 @@

      Call Returns

      returnValue Required - boolean + Boolean

      Indicates the status of operation. Possible values are:

        @@ -1761,7 +1761,7 @@

        Call Returns

        returnValue Required - boolean + Boolean

        Indicates the status of operation. Possible values are:

          @@ -2143,7 +2143,7 @@

          Parameters

          type Required - string + String

          Service type.Valid service types are upnp or bonjour.

          @@ -2151,7 +2151,7 @@

          Parameters

          description Optional - string + String

          Description. Required for upnp service type.

          @@ -2159,7 +2159,7 @@

          Parameters

          query Optional - string + String

          Bonjour query. Required for bonjour service type.

          @@ -2167,7 +2167,7 @@

          Parameters

          response Optional - string + String

          Bonjour response. Required for bonjour service type.

          @@ -2196,7 +2196,7 @@

          Call Returns

          returnValue Required - boolean + Boolean
          • If the method succeeds, returnValue will contain true.
            • @@ -2318,7 +2318,7 @@

            Call Returns

            returnValue Required - boolean + Boolean
            • If the method succeeds, returnValue will contain true.
              • @@ -2439,7 +2439,7 @@

              Parameters

              peerAddress Required - string + String

              Device address of the peer to connect.

              @@ -2476,7 +2476,7 @@

              Call Returns

              returnValue Required - boolean + Boolean
              • If the method succeeds, returnValue will contain true.
                • @@ -2603,13 +2603,13 @@

                Parameters

                ssid Required - string + String SSID of group to create. passPhrase Required - string + String

                Passphrase for connecting to this group. A valid passphrase should have 8 to 63 characters.

                @@ -2638,7 +2638,7 @@

                Call Returns

                returnValue Required - boolean + Boolean
                • If the method succeeds, returnValue will contain true.
                  • @@ -2765,7 +2765,7 @@

                  Parameters

                  deviceAddress Required - string + String Device address or 'all' to delete all existing profiles. @@ -2792,7 +2792,7 @@

                  Call Returns

                  returnValue Required - boolean + Boolean
                  • If the method succeeds, returnValue will contain true.
                    • @@ -2926,7 +2926,7 @@

                    Parameters

                    type Required - string + String

                    Service type. Valid service types are upnp or bonjour.

                    @@ -2934,7 +2934,7 @@

                    Parameters

                    description Optional - string + String

                    Description. Required for upnp service type.

                    @@ -2942,7 +2942,7 @@

                    Parameters

                    query Optional - string + String

                    Bonjour query. Required for bonjour service type.

                    @@ -2971,7 +2971,7 @@

                    Call Returns

                    returnValue Required - boolean + Boolean
                    • If the method succeeds, returnValue will contain true.
                      • @@ -3091,7 +3091,7 @@

                      Parameters

                      peerAddress Required - string + String

                      Device address of the peer to disconnect.

                      @@ -3120,7 +3120,7 @@

                      Call Returns

                      returnValue Required - boolean + Boolean
                      • If the method succeeds, returnValue will contain true.
                        • @@ -3256,7 +3256,7 @@

                        Parameters

                        ssid Required - string + String Name of the group to disconnect. @@ -3283,7 +3283,7 @@

                        Call Returns

                        returnValue Required - boolean + Boolean
                        • If the method succeeds, returnValue will contain true.
                          • @@ -3382,7 +3382,7 @@

                          Example

    p2p/findservice

    -
    ACG: wifi.query
    +
    ACG: wifi.management
    • Added: API level 13
      • @@ -3411,7 +3411,7 @@

      Parameters

      type Required - string + String

      Service type. Valid service types are upnp or bonjour.

      @@ -3419,7 +3419,7 @@

      Parameters

      address Optional - string + String

      A peer to search. If omitted then search for all peers.

      @@ -3435,7 +3435,7 @@

      Parameters

      description Optional - string + String

      Description. Required for upnp service type.

      @@ -3443,7 +3443,7 @@

      Parameters

      query Optional - string + String

      Bonjour query. Required for bonjour service type.

      @@ -3472,7 +3472,7 @@

      Call Returns

      returnValue Required - boolean + Boolean
      • If the method succeeds, returnValue will contain true.
        • @@ -3605,13 +3605,13 @@

        Call Returns

        deviceName Required - string + String The P2P device name. returnValue Required - boolean + Boolean
        • If the method succeeds, returnValue will contain true.
          • @@ -3727,7 +3727,7 @@

          Parameters

          ssid Required - string + String Name of the group. @@ -3762,7 +3762,7 @@

          Call Returns

          returnValue Required - boolean + Boolean
          • If the method succeeds, returnValue will contain true.
            • @@ -3920,7 +3920,7 @@

            Parameters

            subscribe Optional - boolean + Boolean

            To be notified if a group is added, set subscribe to true.

            To be notified if a group is deleted, set subscribe to false.

            @@ -3951,7 +3951,7 @@

            Call Returns

            returnValue Required - boolean + Boolean
            • If the method succeeds, returnValue will contain true.
              • @@ -3986,6 +3986,15 @@

              Call Returns

              See the Error Codes Reference of this method for more details.

              + + subscribed + Optional + Boolean + +

              To be notified if a group is added, set subscribe to true.

              +

              To be notified if a group is deleted, set subscribe to false.

              + +
    @@ -4010,7 +4019,7 @@

    Subscription Returns

    returnValue Required - boolean + Boolean Always true. @@ -4126,7 +4135,7 @@

    Parameters

    subscribe Required - boolean + Boolean

    Subscribe to be notified about any incoming Wi-Fi direct connections. Possible values are:

      @@ -4161,7 +4170,7 @@

      Call Returns

      subscribed Optional - boolean + Boolean

      Indicates if subscribed to get notifications. Possible values are:

        @@ -4173,7 +4182,7 @@

        Call Returns

        returnValue Required - boolean + Boolean

        Indicates the status of operation. Possible values are:

          @@ -4230,7 +4239,7 @@

          Subscription Returns

          returnValue Required - boolean + Boolean

          Indicates the status of operation. Possible values are:

            @@ -4243,19 +4252,19 @@

            Subscription Returns

            deviceAddress Required - string + String Peer address. signalName Required - string + String Signal name. wpsType Required - string + String

            Wi-Fi Protected setup type. Possible values are:

              @@ -4268,7 +4277,7 @@

              Subscription Returns

              wpsPin Optional - string + String

              The PIN for Wi-Fi protected setup if the wpsType argument is display.

              @@ -4276,7 +4285,7 @@

              Subscription Returns

              groupOwner Optional - string + String Indicates if the local endpoint is the owner of the group. @@ -4379,7 +4388,7 @@

              Parameters

              subscribe Optional - boolean + Boolean

              Subscribe and get notified of the changes in the list of peers found. Possible values are:

                @@ -4426,7 +4435,7 @@

                Call Returns

                returnValue Required - boolean + Boolean

                Indicates the status of operation. Possible values are:

                  @@ -4438,7 +4447,7 @@

                  Call Returns

                  subscribed Optional - boolean + Boolean

                  Indicates if subscribed to get notifications. Possible values are:

                    @@ -4450,7 +4459,7 @@

                    Call Returns

                    peers Optional - Object: peerInfo + Object array: WifiPeers

                    Array of objects containing information about the available peers.

                    @@ -4495,7 +4504,7 @@

                    Subscription Returns

                    returnValue Required - boolean + Boolean

                    Indicates the status of operation. Possible values are:

                      @@ -4508,7 +4517,7 @@

                      Subscription Returns

                      peers Required - Object: peerInfo + Object array: WifiPeers

                      Array of objects containing information on Wi-Fi Direct peers.

                      @@ -4656,7 +4665,7 @@

                      Call Returns

                      returnValue Required - boolean + Boolean
                      • If the method succeeds, returnValue will contain true.
                        • @@ -4668,7 +4677,7 @@

                        Call Returns

                        P2P Required - string + String

                        If P2P is enabled then this value is enabled, otherwise it is disabled.

                        @@ -4676,7 +4685,7 @@

                        Call Returns

                        listenState Required - string + String

                        If listening for incoming connections is enabled then this value is enabled , otherwise disabled.

                        @@ -4684,7 +4693,7 @@

                        Call Returns

                        persistentMode Required - string + String

                        If persistent state is enabled  then this value enabled" , "disabled" otherwise.

                        @@ -4813,7 +4822,7 @@

                        Call Returns

                        returnValue Required - boolean + Boolean
                        • If the method succeeds, returnValue will contain true.
                          • @@ -4825,7 +4834,7 @@

                          Call Returns

                          enabled Required - boolean + Boolean

                          true if Wi-Fi Display feature is enabled, false otherwise.

                          @@ -4833,7 +4842,7 @@

                          Call Returns

                          wfdDeviceType Optional - string + String

                          Device type. One of the following: source, primary-sink, secondary-sink, or dual-role.

                          @@ -4841,7 +4850,7 @@

                          Call Returns

                          wfdSessionAvail Optional - boolean + Boolean

                          true if Wi-Fi Direct Session is enabled, false otherwise.

                          @@ -4855,7 +4864,7 @@

                          Call Returns

                          wfdCpSupport Optional - boolean + Boolean

                          true if Content Protection using HDCP System 2.0/2.1 enabled, false otherwise.

                          @@ -4969,7 +4978,7 @@

                          Parameters

                          peerAddress Required - string + String Device address of the peer to invite. @@ -4996,7 +5005,7 @@

                          Call Returns

                          returnValue Required - boolean + Boolean
                          • If the method succeeds, returnValue will contain true.
                            • @@ -5286,7 +5295,7 @@

                            Parameters

                            deviceName Required - string + String

                            Device name to be used.

                            @@ -5315,7 +5324,7 @@

                            Call Returns

                            returnValue Required - boolean + Boolean
                            • If the method succeeds, returnValue will contain true.
                              • @@ -5902,7 +5911,7 @@

                              Parameters

                              P2P Optional - string + String

                              Set to enabled to enable the Wi-Fi direct connection and disabled to disable the Wi-Fi direct connection.

                              @@ -5910,7 +5919,7 @@

                              Parameters

                              listenState Optional - string + String

                              Set the Wi-Fi direct listen state to either enabled or disabled.

                              Enabling listen state will make this device visible on other Wi-Fi direct devices so that it can initiate connection to them.

                              @@ -5919,7 +5928,7 @@

                              Parameters

                              persistentMode Optional - string + String

                              Set the P2P persistent mode to enabled or disabled.

                              Enabling persistent mode will save any group created on this device across reboots.

                              @@ -5949,7 +5958,7 @@

                              Call Returns

                              returnValue Required - boolean + Boolean
                              • If the method succeeds, returnValue will contain true.
                                • @@ -6090,7 +6099,7 @@

                                Parameters

                                ssid Required - string + String

                                SSID of the group.

                                @@ -6098,7 +6107,7 @@

                                Parameters

                                tethering Required - boolean + Boolean

                                To enable tethering , set tethering to true.

                                To disable tethering , set tethering to false.

                                @@ -6128,7 +6137,7 @@

                                Call Returns

                                returnValue Required - boolean + Boolean
                                • If the method succeeds, returnValue will contain true.
                                  • @@ -6269,17 +6278,17 @@

                                  Parameters

                                  enabled Optional - boolean + Boolean

                                  Set to true to enable the Wi-Fi Display feature and false to disable.

                                  -

                                  When the parameter has already set false value, it can not be set false again.

                                  -

                                  Default value: false

                                  +

                                  If it is blank, it is set false

                                  +

                                  we can not set false value cannot be set twice in a row.

                                  deviceType Optional - string + String

                                  Device type. Possible device types are : source, primary-sink, secondary-sink, or dual-role.

                                  @@ -6287,7 +6296,7 @@

                                  Parameters

                                  sessionAvailable Optional - boolean + Boolean

                                  Set to true to enable Wi-Fi Direct Session, false to disable.

                                  @@ -6301,7 +6310,7 @@

                                  Parameters

                                  cpSupport Optional - boolean + Boolean

                                  Set to true to enable Content Protection using HDCP System 2.0/2.1 and false to disable.

                                  @@ -6330,7 +6339,7 @@

                                  Call Returns

                                  returnValue Required - boolean + Boolean
                                  • If the method succeeds, returnValue will contain true.
                                    • @@ -6599,7 +6608,7 @@

                                    Example

    setCountryCode

    -
    ACG: None
    +
    ACG: wifi.management
    • Added: API level 11
      • @@ -6908,7 +6917,7 @@

      Parameters

      wpsPin Optional - string + String

      Pin for WPS-PIN mode.

      @@ -8835,110 +8844,6 @@

      networkInfo

    -

    peerInfo

    -
    -

    Object including information about a peer.

    -
    -

    Example

    -
    -
    -

    - "peerInfo": {
    -     "groupOwner": false,
    -     "signalLevel": 80,
    -     "configMethod": 4488,
    -     "deviceAddress": "02:fc:ef:a0:d0:4a",
    -     "deviceName": "Test Test's G3",
    -     "connected": false,
    -     "deviceType": "00010050f2040005",
    - } -

    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    Name

    -     		-

    Required

    -     		-

    Type

    -     		-

    Description

    -
    deviceNameRequiredString -

    Name of the peer.

    -
    deviceAddressRequiredString -

    Address of the peer.

    -
    groupOwnerRequiredBoolean -

    true if the peer is the owner of the current active group, false otherwise.

    -
    configMethodRequiredNumber -

    Configuration methods supported by the peer.

    -
    signalLevelRequiredNumber -

    Signal level of the peer.

    -
    peerIpOptionalString -

    IP address of the peer if it is currently connected to our group.

    -
    deviceTypeRequiredString -

    Device type of the peer.

    -
    connectedRequiredBoolean -

    Connection status.

    -
    -
    -

    security

    This object is used to provide security information for establishing a connection.

    diff --git a/content/en/docs/reference/ls2-api/com-webos-surfacemanager.html b/content/en/docs/reference/ls2-api/com-webos-surfacemanager.html index 4ed4deee..7f7b2d90 100644 --- a/content/en/docs/reference/ls2-api/com-webos-surfacemanager.html +++ b/content/en/docs/reference/ls2-api/com-webos-surfacemanager.html @@ -1,7 +1,7 @@ --- title: com.webos.surfacemanager -date: 2023-10-31 -api_level: 27 +date: 2024-01-15 +api_level: 28 weight: 370 toc: true --- @@ -20,7 +20,7 @@

    Methods

    captureCompositorOutput

    -
    ACG: surfacemanager.devutility
    +
    ACG: arescli.interface
    • Added: API level 11
      • @@ -697,7 +697,7 @@

      Example

    getForegroundAppInfo

    -
    ACG: webgateway
    +
    ACG: surfacemanager.query
    • Added: API level 11
      • @@ -765,7 +765,7 @@

      Call Returns

      foregroundAppInfo - Required + Optional Object array: foregroundAppInfo

      Information about a surface that is shown in the foreground.

      @@ -822,7 +822,7 @@

      Subscription Returns

      foregroundAppInfo - Required + Optional Object array: foregroundAppInfo

      Information about a surface that is shown in the foreground.

      @@ -859,6 +859,38 @@

      Subscription Returns

    +

    Error Codes Reference

    +
    + + + + + + + + + + + + + + + + + + +
    +

    Error Code

    +     		+

    Error Text

    +     		+

    Error Description

    +
    -1001Invalid parameter type +

    Indicates that parameter is invalid.

    +
    -1000Json parse error +

    Indicates that JSON format is invalid

    +
    +

    Example

    Example: Without subscription

    @@ -938,6 +970,88 @@

    Example

    }

    +
    +

    Example: Multiview (side-by-side)

    +
    +
    +

    # luna-send -n 1 luna://com.webos.surfacemanager/getForegroundAppInfo '{}'
    + {
    +     "foregroundAppInfo": [
    +         {
    +             "appId": "com.webos.app.livetv",
    +             "displayId": 0,
    +             "multiview": true,
    +             "params": {
    +             },
    +             "pip": false,
    +             "primary": true,
    +             "processId": "2419",
    +             "viewType": "mvsxs",
    +             "windowGroup": true,
    +             "windowGroupOwner": true,
    +             "windowGroupOwnerId": "",
    +             "windowType": "_WEBOS_WINDOW_TYPE_CARD"
    +         },
    +         {
    +             "appId": "com.webos.app.browser",
    +             "displayId": 0,
    +             "multiview": true,
    +             "params": {
    +             },
    +             "pip": false,
    +             "primary": false,
    +             "processId": "22382",
    +             "viewType": "mvsxs",
    +             "windowGroup": false,
    +             "windowType": "_WEBOS_WINDOW_TYPE_CARD"
    +         }
    +     ],
    +     "mode": "multiview",
    +     "returnValue": true
    + } +

    +
    +
    +

    Example: Multiview (picture-in-picture)

    +
    +
    +

    # luna-send -n 1 luna://com.webos.surfacemanager/getForegroundAppInfo '{}'
    + {
    +     "foregroundAppInfo": [
    +         {
    +             "appId": "com.webos.app.livetv",
    +             "displayId": 0,
    +             "multiview": true,
    +             "params": {
    +             },
    +             "pip": false,
    +             "primary": true,
    +             "processId": "2419",
    +             "viewType": "mvpip",
    +             "windowGroup": true,
    +             "windowGroupOwner": true,
    +             "windowGroupOwnerId": "",
    +             "windowType": "_WEBOS_WINDOW_TYPE_CARD"
    +         },
    +         {
    +             "appId": "com.webos.app.browser",
    +             "displayId": 0,
    +             "multiview": true,
    +             "params": {
    +             },
    +             "pip": true,
    +             "primary": false,
    +             "processId": "22382",
    +             "viewType": "mvpip",
    +             "windowGroup": false,
    +             "windowType": "_WEBOS_WINDOW_TYPE_CARD"
    +         }
    +     ],
    +     "mode": "multiview",
    +     "returnValue": true
    + } +

    +

    setAppMirroring

    @@ -1258,7 +1372,58 @@

    foregroundAppInfo

    Optional Boolean -

    Whether it is a “main” app as determined by UX policy

    +

    Indicates if it is a "main" app as determined by UX policy.

    +

    Default: false

    + + + + multiview + Optional + Boolean + +

    Indicate whether multivew executes or not. 

    +

    default: false

    + + + + pip + Optional + Boolean + +

    Indicate whether the multi-view mode is pip or not.

    +

    default: false

    + + + + viewType + Optional + String + +

    Indicates additional information about multiview.

    +

    Possible Values are:  

    +
      +
    • normal - fullscreen normal view
      • +
    • mvsxs - multiview and side-by-side
      • +
    • mvpip - multiview and picture-in-picture
      • +
    +

    default: normal

    + + + + displayId + Optional + Number + +

    Indicates the id of display associated with the surface.

    + + + + params + Optional + Object + +

    Indicates the object parameter associated with the surface.

    +

    Note: Empty object(={}) if it has no value.

    diff --git a/content/en/docs/reference/ls2-api/ls2-api-index.html b/content/en/docs/reference/ls2-api/ls2-api-index.html index 2e3d2451..b0ce8616 100644 --- a/content/en/docs/reference/ls2-api/ls2-api-index.html +++ b/content/en/docs/reference/ls2-api/ls2-api-index.html @@ -1,6 +1,6 @@ --- title: LS2 API Index -date: 2023-11-13 +date: 2024-01-17 weight: 1 toc: true --- @@ -18,6 +18,11 @@

    API Levels

    Platform Version

    Release Date

    + +

    28

    +

    webOS OSE 2.25.0

    +

    January 17, 2024

    +

    27

    webOS OSE 2.24.0

    diff --git a/content/en/docs/tools/sdk/cli/cli-release-notes.md b/content/en/docs/tools/sdk/cli/cli-release-notes.md index 195e8602..7412d30b 100644 --- a/content/en/docs/tools/sdk/cli/cli-release-notes.md +++ b/content/en/docs/tools/sdk/cli/cli-release-notes.md @@ -1,7 +1,7 @@ --- title: Release Notes display_title: Command-Line Interface Release Notes -date: 2023-11-13 +date: 2024-01-16 weight: 20 toc: true two_depth_toc: true @@ -42,7 +42,10 @@ The following table shows the compatibility between webOS OSE and CLI. -

    2.4.0

    +

    2.4.0

    +

    2.25.0

    + +

    2.24.0

    diff --git a/static/images/blog/thumbnails/th-release-2-25-0-base-enhancement.png b/static/images/blog/thumbnails/th-release-2-25-0-base-enhancement.png new file mode 100644 index 00000000..6787102c Binary files /dev/null and b/static/images/blog/thumbnails/th-release-2-25-0-base-enhancement.png differ