diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..bee8a64b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +__pycache__ diff --git a/apis/XCast/IXCast.h b/apis/XCast/IXCast.h index 8202e705..5f6adcc1 100644 --- a/apis/XCast/IXCast.h +++ b/apis/XCast/IXCast.h @@ -160,7 +160,7 @@ namespace WPEFramework { /****************************************setEnabled()**********************************/ // @text setEnabled // @brief Enable or disable XCAST service - // @parm enabled: true for enabled or false for disabled + // @param enabled: true for enabled or false for disabled // @param success: Whether the request succeeded virtual Core::hresult SetEnabled(const bool& enabled /* @text enabled */, XCastSuccess& success /* @out */) = 0; /***************************************** setEnabled() **********************************/ diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 99f90abf..12bb83cf 100755 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -14,6 +14,7 @@ - [DisplaySettings@](apis/DisplaySettingsPlugin.md) - [DownloadManager](apis/DownloadManager.md) - [DTV@](apis/DTVPlugin.md) + - [FirmwareDownload](apis/FirmwareDownload.md) - [FirmwareUpdate](apis/FirmwareUpdate.md) - [FrameRate](apis/FrameRate.md) - [FrontPanel](apis/FrontPanel.md) diff --git a/docs/apis/DeviceInfo.md b/docs/apis/DeviceInfo.md index 38a0859e..bfb8512b 100644 --- a/docs/apis/DeviceInfo.md +++ b/docs/apis/DeviceInfo.md @@ -72,7 +72,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.AudioCapabilities | IAudioCapabilityIterator | Audio capability @retval ErrorCode::ERROR_NONE: Indicates success @retval ErrorCode::ERROR_GENERAL: Indicates failure @deprecated | +| result.AudioCapabilities | IAudioCapabilityIterator | Audio capability | | result.AudioCapabilities[#] | string | | | result.success | bool | | @@ -185,7 +185,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.MS12Capabilities | IMS12CapabilityIterator | MS12 audio capability @retval ErrorCode::ERROR_NONE: Indicates success @retval ErrorCode::ERROR_GENERAL: Indicates failure @deprecated | +| result.MS12Capabilities | IMS12CapabilityIterator | MS12 audio capability | | result.MS12Capabilities[#] | string | | | result.success | bool | | @@ -241,7 +241,7 @@ This method takes no parameters. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.supportedAudioPorts | IStringIterator | Audio ports supported on the device. @retval ErrorCode::ERROR_NONE: Indicates success @retval ErrorCode::ERROR_GENERAL: Indicates failure | +| result.supportedAudioPorts | IStringIterator | Audio ports supported on the device. | | result.supportedAudioPorts[#] | string | | | result.success | bool | | @@ -351,7 +351,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.supportedMS12AudioProfiles | IStringIterator | MS12 audio profiles @retval ErrorCode::ERROR_NONE: Indicates success @retval ErrorCode::ERROR_GENERAL: Indicates failure @deprecated | +| result.supportedMS12AudioProfiles | IStringIterator | MS12 audio profiles | | result.supportedMS12AudioProfiles[#] | string | | | result.success | bool | | @@ -410,7 +410,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.supportedResolutions | IStringIterator | Supported Resolutions @retval ErrorCode::ERROR_NONE: Indicates success @retval ErrorCode::ERROR_GENERAL: Indicates failure @deprecated | +| result.supportedResolutions | IStringIterator | Supported Resolutions | | result.supportedResolutions[#] | string | | | result.success | bool | | @@ -466,7 +466,7 @@ This method takes no parameters. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.supportedVideoDisplays | IStringIterator | Video ports supported on the device @retval ErrorCode::ERROR_NONE: Indicates success @retval ErrorCode::ERROR_GENERAL: Indicates failure @deprecated | +| result.supportedVideoDisplays | IStringIterator | Video ports supported on the device | | result.supportedVideoDisplays[#] | string | | | result.success | bool | | @@ -545,7 +545,7 @@ Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).addressesInfo | IAddressesInfoIterator | Network interface addresses @retval ErrorCode::ERROR_NONE: Indicates success @retval ErrorCode::ERROR_GENERAL: Indicates failure | +| (property).addressesInfo | IAddressesInfoIterator | Network interface addresses | | (property).addressesInfo[#].name | string | Interface name | | (property).addressesInfo[#].mac | string | Interface MAC address | | (property).addressesInfo[#].ip | string | Interface IP address | @@ -920,7 +920,7 @@ Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).firmwareVersionInfo | FirmwareversionInfo | Version information @retval ErrorCode::ERROR_NONE: Indicates success @retval ErrorCode::ERROR_GENERAL: Indicates failure | +| (property).firmwareVersionInfo | FirmwareversionInfo | Version information | | (property).firmwareVersionInfo.imagename | string | Image name | | (property).firmwareVersionInfo.sdk | string | sdk version | | (property).firmwareVersionInfo.mediarite | string | mediarite | diff --git a/docs/apis/FirmwareDownload.md b/docs/apis/FirmwareDownload.md new file mode 100644 index 00000000..b5b3da90 --- /dev/null +++ b/docs/apis/FirmwareDownload.md @@ -0,0 +1,344 @@ + + +# FirmwareDownload Plugin + +**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/FirmwareDownload/IFirmwareDownload.h)** + +A FirmwareDownload plugin for Thunder framework. + +### Table of Contents + +- [Abbreviation, Acronyms and Terms](#abbreviation-acronyms-and-terms) +- [Description](#Description) +- [Configuration](#Configuration) +- [Methods](#Methods) +- [Notifications](#Notifications) + + +# Abbreviation, Acronyms and Terms + +[[Refer to this link](overview/aat.md)] + + +# Description + +The `FirmwareDownload` plugin provides an interface for FirmwareDownload. + +The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [[Thunder](https://rdkcentral.github.io/Thunder/)]. + + +# Configuration + +The table below lists configuration options of the plugin. + +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| callsign | string | Plugin instance name (default: org.rdk.FirmwareDownload) | +| classname | string | Class name: *FirmwareDownload* | +| locator | string | Library name: *libWPEFrameworkFirmwareDownload.so* | +| autostart | boolean | Determines if the plugin shall be started automatically along with the framework | + + +# Methods + +The following methods are provided by the FirmwareDownload plugin: + +FirmwareDownload interface methods: + +| Method | Description | +| :-------- | :-------- | +| [getDownloadFailureReason](#getDownloadFailureReason) | Gets the last firmware download failure reason. | +| [getDownloadState](#getDownloadState) | Retrieve the current state of the download process. | +| [getDownloadedFirmwareInfo](#getDownloadedFirmwareInfo) | Returns information about firmware downloads. | +| [getFirmwareDownloadPercent](#getFirmwareDownloadPercent) | Gets the current download percentage. | +| [searchFirmware](#searchFirmware) | Search for any available firmware ( in the remote server - for ex., xconf) that the device can update to. | + + +## *getDownloadFailureReason* + +Gets the last firmware download failure reason. + +### Events +Event details will be updated soon. +### Parameters +This method takes no parameters. +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | object | | +| result.failureReason | string | | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 0, + "method": "org.rdk.FirmwareDownload.getDownloadFailureReason" +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.FirmwareDownload.getDownloadFailureReason"}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 0, + "result": { + "failureReason": "" + } +} +``` + + +## *getDownloadState* + +Retrieve the current state of the download process. + +### Events +Event details will be updated soon. +### Parameters +This method takes no parameters. +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | object | | +| result.downloadState | string | | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 1, + "method": "org.rdk.FirmwareDownload.getDownloadState" +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.FirmwareDownload.getDownloadState"}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 1, + "result": { + "downloadState": "" + } +} +``` + + +## *getDownloadedFirmwareInfo* + +Returns information about firmware downloads. + +### Events +Event details will be updated soon. +### Parameters +This method takes no parameters. +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | object | | +| result.currentFWVersion | string | The current firmware version | +| result.downloadedFWVersion | string | The downloaded firmware version | +| result.downloadedFWLocation | string | The location of the downloaded firmware | +| result.isRebootDeferred | bool | Whether the device should be rebooted | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 2, + "method": "org.rdk.FirmwareDownload.getDownloadedFirmwareInfo" +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.FirmwareDownload.getDownloadedFirmwareInfo"}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 2, + "result": { + "currentFWVersion": "", + "downloadedFWVersion": "", + "downloadedFWLocation": "", + "isRebootDeferred": true + } +} +``` + + +## *getFirmwareDownloadPercent* + +Gets the current download percentage. + +### Events +Event details will be updated soon. +### Parameters +This method takes no parameters. +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | object | | +| result.downloadPercent | integer | | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 3, + "method": "org.rdk.FirmwareDownload.getFirmwareDownloadPercent" +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.FirmwareDownload.getFirmwareDownloadPercent"}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 3, + "result": { + "downloadPercent": 0 + } +} +``` + + +## *searchFirmware* + +Search for any available firmware ( in the remote server - for ex., xconf) that the device can update to. + +### Events +Event details will be updated soon. +### Parameters +This method takes no parameters. +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | null | On success null will be returned. | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 4, + "method": "org.rdk.FirmwareDownload.searchFirmware" +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.FirmwareDownload.searchFirmware"}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 4, + "result": null +} +``` + + + + +# Notifications + +Notifications are autonomous events, triggered by the internals of the implementation, and broadcasted via JSON-RPC to all registered observers. Refer to [[Thunder](https://rdkcentral.github.io/Thunder/)] for information on how to register for a notification. + +The following events are provided by the FirmwareDownload plugin: + +FirmwareDownload interface events: + +| Event | Description | +| :-------- | :-------- | +| [onFirmwareAvailable](#onFirmwareAvailable) | Triggered when the SearchFirmware asynchronous method is invoked | + + +## *onFirmwareAvailable* + +Triggered when the SearchFirmware asynchronous method is invoked + +### Parameters +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.searchStatus | int | Status of the firmware search operation | +| params.serverResponse | string | Response message from the server | +| params.firmwareAvailable | bool | Indicates whether new firmware is available | +| params.firmwareVersion | string | Version string of the available firmware | +| params.rebootImmediately | bool | Indicates whether immediate reboot is required | + +### Examples + +```json +{ + "jsonrpc": 2.0, + "id": 5, + "method": "org.rdk.FirmwareDownload.onFirmwareAvailable", + "params": { + "searchStatus": 0, + "serverResponse": "", + "firmwareAvailable": true, + "firmwareVersion": "", + "rebootImmediately": true + } +} +``` diff --git a/docs/apis/OCIContainer.md b/docs/apis/OCIContainer.md index 3c2011d4..5e0a0818 100644 --- a/docs/apis/OCIContainer.md +++ b/docs/apis/OCIContainer.md @@ -74,9 +74,9 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.key | string | name of property | -| params.value | string | property data @retval ErrorCode::NONE: Indicates successful state change | +| params.value | string | property data | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -134,7 +134,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params?.options | string | (optional)options to be passed to command | | params.command | string | command to run in container | ### Results @@ -194,7 +194,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -252,7 +252,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -310,7 +310,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.options | string | options to be passed to command | ### Results | Name | Type | Description | @@ -370,7 +370,7 @@ This method takes no parameters. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.containers | string | /json - string @retval ErrorCode::NONE: Indicates successful state change | +| result.containers | string | /json - string | | result.success | bool | | | result.errorReason | string | | @@ -420,7 +420,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.source | string | path source to mount | | params.target | string | mount target inside container | | params.type | string | type of mounting | @@ -484,7 +484,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -540,7 +540,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.key | string | name of property | ### Results | Name | Type | Description | @@ -598,7 +598,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -654,10 +654,10 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.bundlePath | string | path of application bundle | | params?.command | string | (optional)command to run in container | -| params?.westerosSocket | string | (optional)Westeros socket container need to connect @retval ErrorCode::NONE: Indicates successful state change | +| params?.westerosSocket | string | (optional)Westeros socket container need to connect | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -718,10 +718,10 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.dobbySpec | string | dobby specification as json string | | params?.command | string | (optional)command to run in container | -| params?.westerosSocket | string | (optional)Westeros socket container need to connect @retval ErrorCode::NONE: Indicates successful state change | +| params?.westerosSocket | string | (optional)Westeros socket container need to connect | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -782,8 +782,8 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | -| params?.force | bool | (optional)Mention forceful or graceful termination of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | +| params?.force | bool | (optional)Mention forceful or graceful termination of container | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -840,7 +840,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.target | string | mount target inside container | ### Results | Name | Type | Description | @@ -898,7 +898,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | ### Results | Name | Type | Description | | :-------- | :-------- | :-------- | @@ -970,7 +970,7 @@ Notifies failure in container execution, only triggered for states start, stop, | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.name | string | | | params.error | integer | | @@ -998,7 +998,7 @@ Notifies container is started | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.name | string | | ### Examples @@ -1024,7 +1024,7 @@ Notifies state change of container | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.state | string | | ### Examples @@ -1050,7 +1050,7 @@ Notifies container is stopped | Name | Type | Description | | :-------- | :-------- | :-------- | | params | object | | -| params.containerId | string | Identifier of container @retval ErrorCode::NONE: Indicates successful state change | +| params.containerId | string | Identifier of container | | params.name | string | | ### Examples diff --git a/docs/apis/PlayerInfo.md b/docs/apis/PlayerInfo.md index f6aef6a2..c04e95af 100644 --- a/docs/apis/PlayerInfo.md +++ b/docs/apis/PlayerInfo.md @@ -2,7 +2,7 @@ # PlayerInfo Plugin -**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/PlayerInfo/IPlayerInfo.h)** +**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/PlayerInfo/IDolby.h)** A PlayerInfo plugin for Thunder framework. @@ -47,19 +47,19 @@ PlayerInfo interface properties: | Property | Description | | :-------- | :-------- | -| [audioCodecs](#audioCodecs)RO | | -| [isAudioEquivalenceEnabled](#isAudioEquivalenceEnabled)RO | Checks Loudness Equivalence in platform | -| [resolution](#resolution)RO | Current Video playback resolution | -| [videoCodecs](#videoCodecs)RO | | | [dolby_atmosmetadata](#dolby_atmosmetadata)RO | Atmos capabilities of Sink | | [dolby_enableatmosoutput](#dolby_enableatmosoutput)WO | Enable Atmos Audio Output | | [dolby_mode](#dolby_mode) | Dolby Mode | | [dolby_soundmode](#dolby_soundmode)RO | Sound Mode - Mono/Stereo/Surround | +| [audioCodecs](#audioCodecs)RO | | +| [isAudioEquivalenceEnabled](#isAudioEquivalenceEnabled)RO | Checks Loudness Equivalence in platform | +| [resolution](#resolution)RO | Current Video playback resolution | +| [videoCodecs](#videoCodecs)RO | | - -## *AudioCodecs* - + +## *AtmosMetadata* +Atmos capabilities of Sink > This property is read-only. ### Events @@ -67,8 +67,7 @@ Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).codec | IAudioCodecIterator | | -| (property).codec[#] | string | | +| (property).supported | bool | | ### Examples @@ -78,8 +77,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 0, - "method": "org.rdk.PlayerInfo.audioCodecs" + "id": 1, + "method": "org.rdk.PlayerInfo.atmosMetadata" } ``` @@ -87,7 +86,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.PlayerInfo.audioCodecs"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.PlayerInfo.atmosMetadata"}' http://127.0.0.1:9998/jsonrpc ``` @@ -96,36 +95,39 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "met ```json { "jsonrpc": 2.0, - "id": 0, - "result": [ - "AUDIO_UNDEFINED" - ] + "id": 1, + "result": { + "supported": true + } } ``` - -## *IsAudioEquivalenceEnabled* + +## *EnableAtmosOutput* -Checks Loudness Equivalence in platform +Enable Atmos Audio Output -> This property is read-only. +> This property is write-only. ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).ae | bool | enabled/disabled | +| (property).enable | bool | enable/disable | ### Examples -#### Get Request +#### Set Request ```json { "jsonrpc": 2.0, - "id": 1, - "method": "org.rdk.PlayerInfo.isAudioEquivalenceEnabled" + "id": 2, + "method": "org.rdk.PlayerInfo.enableAtmosOutput", + "params": { + "enable": true + } } ``` @@ -133,34 +135,31 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.PlayerInfo.isAudioEquivalenceEnabled"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.PlayerInfo.enableAtmosOutput", "params": {"enable": true}}' http://127.0.0.1:9998/jsonrpc ``` -#### Get Response +#### Set Response ```json { "jsonrpc": 2.0, - "id": 1, - "result": { - "ae": true - } + "id": 2, + "result": null } ``` - -## *Resolution* + +## *Mode* -Current Video playback resolution +Dolby Mode -> This property is read-only. ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).res | string | resolution | +| (property).mode | string | dolby mode type | ### Examples @@ -170,8 +169,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 2, - "method": "org.rdk.PlayerInfo.resolution" + "id": 3, + "method": "org.rdk.PlayerInfo.mode" } ``` @@ -179,7 +178,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.PlayerInfo.resolution"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.PlayerInfo.mode"}' http://127.0.0.1:9998/jsonrpc ``` @@ -188,37 +187,24 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "met ```json { "jsonrpc": 2.0, - "id": 2, + "id": 3, "result": { - "res": "RESOLUTION_UNKNOWN" + "mode": "DIGITAL_PCM" } } ``` - -## *VideoCodecs* - - - -> This property is read-only. -### Events -Event details will be updated soon. -### Values -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| (property).codec | IVideoCodecIterator | | -| (property).codec[#] | string | | - -### Examples - -#### Get Request +#### Set Request ```json { "jsonrpc": 2.0, "id": 3, - "method": "org.rdk.PlayerInfo.videoCodecs" + "method": "org.rdk.PlayerInfo.mode", + "params": { + "mode": "DIGITAL_PCM" + } } ``` @@ -226,26 +212,24 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.PlayerInfo.videoCodecs"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.PlayerInfo.mode", "params": {"mode": "DIGITAL_PCM"}}' http://127.0.0.1:9998/jsonrpc ``` -#### Get Response +#### Set Response ```json { "jsonrpc": 2.0, "id": 3, - "result": [ - "VIDEO_UNDEFINED" - ] + "result": null } ``` - -## *AtmosMetadata* + +## *SoundMode* -Atmos capabilities of Sink +Sound Mode - Mono/Stereo/Surround > This property is read-only. ### Events @@ -253,7 +237,7 @@ Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).supported | bool | | +| (property).mode | string | | ### Examples @@ -263,8 +247,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 1, - "method": "org.rdk.PlayerInfo.atmosMetadata" + "id": 4, + "method": "org.rdk.PlayerInfo.soundMode" } ``` @@ -272,7 +256,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.PlayerInfo.atmosMetadata"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.PlayerInfo.soundMode"}' http://127.0.0.1:9998/jsonrpc ``` @@ -281,39 +265,37 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "met ```json { "jsonrpc": 2.0, - "id": 1, + "id": 4, "result": { - "supported": true + "mode": "UNKNOWN" } } ``` - -## *EnableAtmosOutput* + +## *AudioCodecs* -Enable Atmos Audio Output -> This property is write-only. + +> This property is read-only. ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).enable | bool | enable/disable | +| (property).codec | IAudioCodecIterator | | +| (property).codec[#] | string | | ### Examples -#### Set Request +#### Get Request ```json { "jsonrpc": 2.0, - "id": 2, - "method": "org.rdk.PlayerInfo.enableAtmosOutput", - "params": { - "enable": true - } + "id": 0, + "method": "org.rdk.PlayerInfo.audioCodecs" } ``` @@ -321,31 +303,34 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.PlayerInfo.enableAtmosOutput", "params": {"enable": true}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.PlayerInfo.audioCodecs"}' http://127.0.0.1:9998/jsonrpc ``` -#### Set Response +#### Get Response ```json { "jsonrpc": 2.0, - "id": 2, - "result": null + "id": 0, + "result": [ + "AUDIO_UNDEFINED" + ] } ``` - -## *Mode* + +## *IsAudioEquivalenceEnabled* -Dolby Mode +Checks Loudness Equivalence in platform +> This property is read-only. ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).mode | string | dolby mode type | +| (property).ae | bool | enabled/disabled | ### Examples @@ -355,8 +340,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 3, - "method": "org.rdk.PlayerInfo.mode" + "id": 1, + "method": "org.rdk.PlayerInfo.isAudioEquivalenceEnabled" } ``` @@ -364,7 +349,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.PlayerInfo.mode"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.PlayerInfo.isAudioEquivalenceEnabled"}' http://127.0.0.1:9998/jsonrpc ``` @@ -373,24 +358,36 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "met ```json { "jsonrpc": 2.0, - "id": 3, + "id": 1, "result": { - "mode": "DIGITAL_PCM" + "ae": true } } ``` + +## *Resolution* -#### Set Request +Current Video playback resolution + +> This property is read-only. +### Events +Event details will be updated soon. +### Values +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| (property).res | string | resolution | + +### Examples + + +#### Get Request ```json { "jsonrpc": 2.0, - "id": 3, - "method": "org.rdk.PlayerInfo.mode", - "params": { - "mode": "DIGITAL_PCM" - } + "id": 2, + "method": "org.rdk.PlayerInfo.resolution" } ``` @@ -398,24 +395,26 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "met #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.PlayerInfo.mode", "params": {"mode": "DIGITAL_PCM"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.PlayerInfo.resolution"}' http://127.0.0.1:9998/jsonrpc ``` -#### Set Response +#### Get Response ```json { "jsonrpc": 2.0, - "id": 3, - "result": null + "id": 2, + "result": { + "res": "RESOLUTION_UNKNOWN" + } } ``` - -## *SoundMode* + +## *VideoCodecs* + -Sound Mode - Mono/Stereo/Surround > This property is read-only. ### Events @@ -423,7 +422,8 @@ Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).mode | string | | +| (property).codec | IVideoCodecIterator | | +| (property).codec[#] | string | | ### Examples @@ -433,8 +433,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 4, - "method": "org.rdk.PlayerInfo.soundMode" + "id": 3, + "method": "org.rdk.PlayerInfo.videoCodecs" } ``` @@ -442,7 +442,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.PlayerInfo.soundMode"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.PlayerInfo.videoCodecs"}' http://127.0.0.1:9998/jsonrpc ``` @@ -451,10 +451,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met ```json { "jsonrpc": 2.0, - "id": 4, - "result": { - "mode": "UNKNOWN" - } + "id": 3, + "result": [ + "VIDEO_UNDEFINED" + ] } ``` diff --git a/docs/apis/RDKWindowManager.md b/docs/apis/RDKWindowManager.md index 76508ccb..28af34c3 100644 --- a/docs/apis/RDKWindowManager.md +++ b/docs/apis/RDKWindowManager.md @@ -646,7 +646,7 @@ This method takes no parameters. | result | object | | | result.keyCode | integer | Key code to be injected, modifiers : JSON String format with one or more modifiers | | result.modifiers | integer | Output parameter. The modifier flags (e.g., Shift, Ctrl) active during the last key press. | -| result.timestampInSeconds | integer | Output parameter. The timestamp (in seconds) when the last key press occurred. @retval Core::ERROR_NONE: Successfully retrieved the last key press information. @retval Core::ERROR_UNAVAILABLE: No key press information is available. | +| result.timestampInSeconds | integer | Output parameter. The timestamp (in seconds) when the last key press occurred. | ### Examples diff --git a/docs/apis/ScreenCapture.md b/docs/apis/ScreenCapture.md index dbc80691..ac223f13 100644 --- a/docs/apis/ScreenCapture.md +++ b/docs/apis/ScreenCapture.md @@ -47,13 +47,13 @@ ScreenCapture interface methods: | Method | Description | | :-------- | :-------- | -| [sendScreenshot](#sendScreenshot) |Takes screenshot and uploads it to a specified URL, where the URL value is retrieved from an RFC parameter named Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.ScreenCapture.URL and Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.ScreenCapture.Enable that check whether screencapture is enabled.@param: callGUID - A unique identifier of a call. The identifier is used to find a corresponding uploadComplete event @param: result - Whether the request succeeded | +| [sendScreenshot](#sendScreenshot) | Takes a screenshot and uploads it to the specified URL | | [uploadScreenCapture](#uploadScreenCapture) | Takes a screenshot and uploads it to the specified URL | ## *sendScreenshot* -Takes a screenshot and uploads it to the specified URL @param: callGUID - A unique identifier of a call. The identifier is used to find a corresponding uploadComplete event @param: result - Whether the request succeeded +Takes a screenshot and uploads it to the specified URL ### Events Event details will be updated soon. diff --git a/docs/apis/TextTrack.md b/docs/apis/TextTrack.md index 53d064fe..7148f390 100644 --- a/docs/apis/TextTrack.md +++ b/docs/apis/TextTrack.md @@ -47,6 +47,8 @@ TextTrack interface methods: | Method | Description | | :-------- | :-------- | +| [applyCustomTtmlStyleOverridesToSession](#applyCustomTtmlStyleOverridesToSession) | Applies a custom TTML styling with overrides that is applied on all elements | +| [associateVideoDecoder](#associateVideoDecoder) | Associate a video decoder with the given session | | [closeSession](#closeSession) | Closes a previously opened render session. | | [getBackgroundColor](#getBackgroundColor) | Getter for BackgroundColor | | [getBackgroundOpacity](#getBackgroundOpacity) | Getter for BackgroundOpacity | @@ -59,6 +61,7 @@ TextTrack interface methods: | [getFontFamily](#getFontFamily) | Getter for FontFamily | | [getFontOpacity](#getFontOpacity) | Getter for FontOpacity | | [getFontSize](#getFontSize) | Getter for FontSize | +| [getInterfaceVersion](#getInterfaceVersion) | Return the interface version implemented | | [getTtmlStyleOverrides](#getTtmlStyleOverrides) | Gets the global TTML style overrides | | [getWindowColor](#getWindowColor) | Getter for WindowColor | | [getWindowOpacity](#getWindowOpacity) | Getter for WindowOpacity | @@ -90,6 +93,112 @@ TextTrack interface methods: | [setWindowOpacity](#setWindowOpacity) | Setter for WindowOpacity | | [unMuteSession](#unMuteSession) | UnMute will unhide the rendering of Captions. | + +## *applyCustomTtmlStyleOverridesToSession* + +When a custom styling override is applied on a specific TTML session, the styling carried on the data for the specified element is overridden. For styling options, see https://www.w3.org/TR/2018/REC-ttml1-20181108/#styling-vocabulary-style The format of the styling string is "attr:value;attr:value;attr:value" (see vocabulary; NB: not all styling is supported) Styles not mentioned in the list will not be affected. Added in version 2 + +### Events +Event details will be updated soon. +### Parameters +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.sessionId | integer | On success the returned session id | +| params.style | string | Contains the chosen override for styles | +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | null | On success null will be returned. | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 0, + "method": "org.rdk.TextTrack.applyCustomTtmlStyleOverridesToSession", + "params": { + "sessionId": 1, + "style": "" + } +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.TextTrack.applyCustomTtmlStyleOverridesToSession", "params": {"sessionId": 1, "style": ""}}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 0, + "result": null +} +``` + + +## *associateVideoDecoder* + +This will ask TextTrack to subscribe to Closed Captions data from the decoder and display these in the given session. Depending on the support on the platform, this may not be possible to do. The association is active until CloseSession() or ResetSession() is called, and can also be cancelled by calling AssociateVideoDecoder() with an empty string for handle. After associating the video decoder, further calls to SendSessionData will be ignored. Added in version 3 + +### Events +Event details will be updated soon. +### Parameters +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.sessionId | integer | On success the returned session id | +| params.handle | string | is a textual representation of the video decoder handle | +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | null | On success null will be returned. | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 1, + "method": "org.rdk.TextTrack.associateVideoDecoder", + "params": { + "sessionId": 1, + "handle": "" + } +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.TextTrack.associateVideoDecoder", "params": {"sessionId": 1, "handle": ""}}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 1, + "result": null +} +``` + ## *closeSession* @@ -115,7 +224,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 0, + "id": 2, "method": "org.rdk.TextTrack.closeSession", "params": { "sessionId": 1 @@ -127,7 +236,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.TextTrack.closeSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.TextTrack.closeSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc ``` @@ -136,7 +245,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "met ```json { "jsonrpc": 2.0, - "id": 0, + "id": 2, "result": null } ``` @@ -164,7 +273,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 1, + "id": 3, "method": "org.rdk.TextTrack.getBackgroundColor" } ``` @@ -173,7 +282,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "method": "org.rdk.TextTrack.getBackgroundColor"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.TextTrack.getBackgroundColor"}' http://127.0.0.1:9998/jsonrpc ``` @@ -182,7 +291,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 1, "met ```json { "jsonrpc": 2.0, - "id": 1, + "id": 3, "result": { "color": "" } @@ -212,7 +321,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 2, + "id": 4, "method": "org.rdk.TextTrack.getBackgroundOpacity" } ``` @@ -221,7 +330,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.TextTrack.getBackgroundOpacity"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.TextTrack.getBackgroundOpacity"}' http://127.0.0.1:9998/jsonrpc ``` @@ -230,7 +339,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "met ```json { "jsonrpc": 2.0, - "id": 2, + "id": 4, "result": { "opacity": 0 } @@ -250,7 +359,7 @@ This method takes no parameters. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.capabilities | IIterator | Iterator providing the list of supported capabilities. @retval Core::ERROR_NONE The list of capabilities was retrieved successfully. @retval Core::ERROR_NOT_SUPPORTED Retrieving capabilities is not supported. | +| result.capabilities | IIterator | Iterator providing the list of supported capabilities. | | result.capabilities[#] | string | | ### Examples @@ -261,7 +370,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 3, + "id": 5, "method": "org.rdk.TextTrack.getCapabilities" } ``` @@ -270,7 +379,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.TextTrack.getCapabilities"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.TextTrack.getCapabilities"}' http://127.0.0.1:9998/jsonrpc ``` @@ -279,7 +388,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "met ```json { "jsonrpc": 2.0, - "id": 3, + "id": 5, "result": [ "UNSET" ] @@ -302,7 +411,7 @@ Event details will be updated soon. | Name | Type | Description | | :-------- | :-------- | :-------- | | result | object | | -| result.hasCapability | bool | Indicates whether the queried capability is supported. @retval Core::ERROR_NONE The capability query completed successfully. @retval Core::ERROR_NOT_SUPPORTED Capability querying is not supported. | +| result.hasCapability | bool | Indicates whether the queried capability is supported. | ### Examples @@ -312,7 +421,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 4, + "id": 6, "method": "org.rdk.TextTrack.getCapability", "params": { "capability": "FIREBOLT_MIGRATION" @@ -324,7 +433,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.TextTrack.getCapability", "params": {"capability": "FIREBOLT_MIGRATION"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "method": "org.rdk.TextTrack.getCapability", "params": {"capability": "FIREBOLT_MIGRATION"}}' http://127.0.0.1:9998/jsonrpc ``` @@ -333,7 +442,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met ```json { "jsonrpc": 2.0, - "id": 4, + "id": 6, "result": { "hasCapability": true } @@ -373,7 +482,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 5, + "id": 7, "method": "org.rdk.TextTrack.getClosedCaptionsStyle" } ``` @@ -382,7 +491,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.TextTrack.getClosedCaptionsStyle"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "method": "org.rdk.TextTrack.getClosedCaptionsStyle"}' http://127.0.0.1:9998/jsonrpc ``` @@ -391,7 +500,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "met ```json { "jsonrpc": 2.0, - "id": 5, + "id": 7, "result": { "fontFamily": "CONTENT_DEFAULT", "fontSize": "CONTENT_DEFAULT", @@ -430,7 +539,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 6, + "id": 8, "method": "org.rdk.TextTrack.getFontColor" } ``` @@ -439,7 +548,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "method": "org.rdk.TextTrack.getFontColor"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "method": "org.rdk.TextTrack.getFontColor"}' http://127.0.0.1:9998/jsonrpc ``` @@ -448,7 +557,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "met ```json { "jsonrpc": 2.0, - "id": 6, + "id": 8, "result": { "color": "" } @@ -478,7 +587,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 7, + "id": 9, "method": "org.rdk.TextTrack.getFontEdge" } ``` @@ -487,7 +596,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "method": "org.rdk.TextTrack.getFontEdge"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 9, "method": "org.rdk.TextTrack.getFontEdge"}' http://127.0.0.1:9998/jsonrpc ``` @@ -496,7 +605,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "met ```json { "jsonrpc": 2.0, - "id": 7, + "id": 9, "result": { "edge": "CONTENT_DEFAULT" } @@ -526,7 +635,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 8, + "id": 10, "method": "org.rdk.TextTrack.getFontEdgeColor" } ``` @@ -535,7 +644,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "method": "org.rdk.TextTrack.getFontEdgeColor"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "method": "org.rdk.TextTrack.getFontEdgeColor"}' http://127.0.0.1:9998/jsonrpc ``` @@ -544,7 +653,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 8, "met ```json { "jsonrpc": 2.0, - "id": 8, + "id": 10, "result": { "color": "" } @@ -574,7 +683,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 9, + "id": 11, "method": "org.rdk.TextTrack.getFontFamily" } ``` @@ -583,7 +692,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 9, "method": "org.rdk.TextTrack.getFontFamily"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "method": "org.rdk.TextTrack.getFontFamily"}' http://127.0.0.1:9998/jsonrpc ``` @@ -592,7 +701,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 9, "met ```json { "jsonrpc": 2.0, - "id": 9, + "id": 11, "result": { "font": "CONTENT_DEFAULT" } @@ -622,7 +731,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 10, + "id": 12, "method": "org.rdk.TextTrack.getFontOpacity" } ``` @@ -631,7 +740,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "method": "org.rdk.TextTrack.getFontOpacity"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "method": "org.rdk.TextTrack.getFontOpacity"}' http://127.0.0.1:9998/jsonrpc ``` @@ -640,7 +749,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 10, "me ```json { "jsonrpc": 2.0, - "id": 10, + "id": 12, "result": { "opacity": 0 } @@ -670,7 +779,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 11, + "id": 13, "method": "org.rdk.TextTrack.getFontSize" } ``` @@ -679,7 +788,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "method": "org.rdk.TextTrack.getFontSize"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "method": "org.rdk.TextTrack.getFontSize"}' http://127.0.0.1:9998/jsonrpc ``` @@ -688,13 +797,61 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "me ```json { "jsonrpc": 2.0, - "id": 11, + "id": 13, "result": { "size": "CONTENT_DEFAULT" } } ``` + +## *getInterfaceVersion* + +This allows to query the running plugin for the version of the interface it was compiled to support. This information can be helpful in determining whether a certain functionality can be expected to be present. Added in version 4 + +### Events +Event details will be updated soon. +### Parameters +This method takes no parameters. +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | object | | +| result.version | integer | will receive the version number | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 14, + "method": "org.rdk.TextTrack.getInterfaceVersion" +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "method": "org.rdk.TextTrack.getInterfaceVersion"}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 14, + "result": { + "version": 4 + } +} +``` + ## *getTtmlStyleOverrides* @@ -718,7 +875,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 12, + "id": 15, "method": "org.rdk.TextTrack.getTtmlStyleOverrides" } ``` @@ -727,7 +884,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "method": "org.rdk.TextTrack.getTtmlStyleOverrides"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "method": "org.rdk.TextTrack.getTtmlStyleOverrides"}' http://127.0.0.1:9998/jsonrpc ``` @@ -736,7 +893,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "me ```json { "jsonrpc": 2.0, - "id": 12, + "id": 15, "result": { "style": "" } @@ -766,7 +923,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 13, + "id": 16, "method": "org.rdk.TextTrack.getWindowColor" } ``` @@ -775,7 +932,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "method": "org.rdk.TextTrack.getWindowColor"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "method": "org.rdk.TextTrack.getWindowColor"}' http://127.0.0.1:9998/jsonrpc ``` @@ -784,7 +941,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "me ```json { "jsonrpc": 2.0, - "id": 13, + "id": 16, "result": { "color": "" } @@ -814,7 +971,7 @@ This method takes no parameters. ```json { "jsonrpc": 2.0, - "id": 14, + "id": 17, "method": "org.rdk.TextTrack.getWindowOpacity" } ``` @@ -823,7 +980,7 @@ This method takes no parameters. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "method": "org.rdk.TextTrack.getWindowOpacity"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "method": "org.rdk.TextTrack.getWindowOpacity"}' http://127.0.0.1:9998/jsonrpc ``` @@ -832,7 +989,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "me ```json { "jsonrpc": 2.0, - "id": 14, + "id": 17, "result": { "opacity": 0 } @@ -864,7 +1021,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 15, + "id": 18, "method": "org.rdk.TextTrack.muteSession", "params": { "sessionId": 1 @@ -876,7 +1033,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "method": "org.rdk.TextTrack.muteSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "method": "org.rdk.TextTrack.muteSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc ``` @@ -885,7 +1042,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "me ```json { "jsonrpc": 2.0, - "id": 15, + "id": 18, "result": null } ``` @@ -916,7 +1073,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 16, + "id": 19, "method": "org.rdk.TextTrack.openSession", "params": { "displayHandle": "" @@ -928,7 +1085,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "method": "org.rdk.TextTrack.openSession", "params": {"displayHandle": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "method": "org.rdk.TextTrack.openSession", "params": {"displayHandle": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -937,7 +1094,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "me ```json { "jsonrpc": 2.0, - "id": 16, + "id": 19, "result": { "sessionId": 1 } @@ -969,7 +1126,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 17, + "id": 20, "method": "org.rdk.TextTrack.pauseSession", "params": { "sessionId": 1 @@ -981,7 +1138,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "method": "org.rdk.TextTrack.pauseSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "method": "org.rdk.TextTrack.pauseSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc ``` @@ -990,7 +1147,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "me ```json { "jsonrpc": 2.0, - "id": 17, + "id": 20, "result": null } ``` @@ -1020,7 +1177,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 18, + "id": 21, "method": "org.rdk.TextTrack.resetSession", "params": { "sessionId": 1 @@ -1032,7 +1189,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "method": "org.rdk.TextTrack.resetSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "method": "org.rdk.TextTrack.resetSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1041,7 +1198,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "me ```json { "jsonrpc": 2.0, - "id": 18, + "id": 21, "result": null } ``` @@ -1071,7 +1228,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 19, + "id": 22, "method": "org.rdk.TextTrack.resumeSession", "params": { "sessionId": 1 @@ -1083,7 +1240,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "method": "org.rdk.TextTrack.resumeSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "method": "org.rdk.TextTrack.resumeSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1092,7 +1249,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "me ```json { "jsonrpc": 2.0, - "id": 19, + "id": 22, "result": null } ``` @@ -1125,7 +1282,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 20, + "id": 23, "method": "org.rdk.TextTrack.sendSessionData", "params": { "sessionId": 1, @@ -1140,7 +1297,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "method": "org.rdk.TextTrack.sendSessionData", "params": {"sessionId": 1, "type": "PES", "displayOffsetMs": 0, "data": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 23, "method": "org.rdk.TextTrack.sendSessionData", "params": {"sessionId": 1, "type": "PES", "displayOffsetMs": 0, "data": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1149,7 +1306,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "me ```json { "jsonrpc": 2.0, - "id": 20, + "id": 23, "result": null } ``` @@ -1180,7 +1337,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 21, + "id": 24, "method": "org.rdk.TextTrack.sendSessionTimestamp", "params": { "sessionId": 1, @@ -1193,7 +1350,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "method": "org.rdk.TextTrack.sendSessionTimestamp", "params": {"sessionId": 1, "mediaTimestampMs": 0}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 24, "method": "org.rdk.TextTrack.sendSessionTimestamp", "params": {"sessionId": 1, "mediaTimestampMs": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1202,7 +1359,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "me ```json { "jsonrpc": 2.0, - "id": 21, + "id": 24, "result": null } ``` @@ -1232,7 +1389,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 22, + "id": 25, "method": "org.rdk.TextTrack.setBackgroundColor", "params": { "color": "" @@ -1244,7 +1401,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "method": "org.rdk.TextTrack.setBackgroundColor", "params": {"color": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 25, "method": "org.rdk.TextTrack.setBackgroundColor", "params": {"color": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1253,7 +1410,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "me ```json { "jsonrpc": 2.0, - "id": 22, + "id": 25, "result": null } ``` @@ -1283,7 +1440,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 23, + "id": 26, "method": "org.rdk.TextTrack.setBackgroundOpacity", "params": { "opacity": 0 @@ -1295,7 +1452,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 23, "method": "org.rdk.TextTrack.setBackgroundOpacity", "params": {"opacity": 0}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 26, "method": "org.rdk.TextTrack.setBackgroundOpacity", "params": {"opacity": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1304,7 +1461,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 23, "me ```json { "jsonrpc": 2.0, - "id": 23, + "id": 26, "result": null } ``` @@ -1344,7 +1501,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 24, + "id": 27, "method": "org.rdk.TextTrack.setClosedCaptionsStyle", "params": { "fontFamily": "CONTENT_DEFAULT", @@ -1365,7 +1522,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 24, "method": "org.rdk.TextTrack.setClosedCaptionsStyle", "params": {"fontFamily": "CONTENT_DEFAULT", "fontSize": "CONTENT_DEFAULT", "fontColor": "", "fontOpacity": 0, "fontEdge": "CONTENT_DEFAULT", "fontEdgeColor": "", "backgroundColor": "", "backgroundOpacity": 0, "windowColor": "", "windowOpacity": 0}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 27, "method": "org.rdk.TextTrack.setClosedCaptionsStyle", "params": {"fontFamily": "CONTENT_DEFAULT", "fontSize": "CONTENT_DEFAULT", "fontColor": "", "fontOpacity": 0, "fontEdge": "CONTENT_DEFAULT", "fontEdgeColor": "", "backgroundColor": "", "backgroundOpacity": 0, "windowColor": "", "windowOpacity": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1374,7 +1531,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 24, "me ```json { "jsonrpc": 2.0, - "id": 24, + "id": 27, "result": null } ``` @@ -1404,7 +1561,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 25, + "id": 28, "method": "org.rdk.TextTrack.setFontColor", "params": { "color": "" @@ -1416,7 +1573,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 25, "method": "org.rdk.TextTrack.setFontColor", "params": {"color": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 28, "method": "org.rdk.TextTrack.setFontColor", "params": {"color": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1425,7 +1582,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 25, "me ```json { "jsonrpc": 2.0, - "id": 25, + "id": 28, "result": null } ``` @@ -1455,7 +1612,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 26, + "id": 29, "method": "org.rdk.TextTrack.setFontEdge", "params": { "edge": "CONTENT_DEFAULT" @@ -1467,7 +1624,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 26, "method": "org.rdk.TextTrack.setFontEdge", "params": {"edge": "CONTENT_DEFAULT"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 29, "method": "org.rdk.TextTrack.setFontEdge", "params": {"edge": "CONTENT_DEFAULT"}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1476,7 +1633,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 26, "me ```json { "jsonrpc": 2.0, - "id": 26, + "id": 29, "result": null } ``` @@ -1506,7 +1663,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 27, + "id": 30, "method": "org.rdk.TextTrack.setFontEdgeColor", "params": { "color": "" @@ -1518,7 +1675,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 27, "method": "org.rdk.TextTrack.setFontEdgeColor", "params": {"color": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 30, "method": "org.rdk.TextTrack.setFontEdgeColor", "params": {"color": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1527,7 +1684,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 27, "me ```json { "jsonrpc": 2.0, - "id": 27, + "id": 30, "result": null } ``` @@ -1557,7 +1714,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 28, + "id": 31, "method": "org.rdk.TextTrack.setFontFamily", "params": { "font": "CONTENT_DEFAULT" @@ -1569,7 +1726,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 28, "method": "org.rdk.TextTrack.setFontFamily", "params": {"font": "CONTENT_DEFAULT"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 31, "method": "org.rdk.TextTrack.setFontFamily", "params": {"font": "CONTENT_DEFAULT"}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1578,7 +1735,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 28, "me ```json { "jsonrpc": 2.0, - "id": 28, + "id": 31, "result": null } ``` @@ -1608,7 +1765,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 29, + "id": 32, "method": "org.rdk.TextTrack.setFontOpacity", "params": { "opacity": 0 @@ -1620,7 +1777,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 29, "method": "org.rdk.TextTrack.setFontOpacity", "params": {"opacity": 0}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 32, "method": "org.rdk.TextTrack.setFontOpacity", "params": {"opacity": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1629,7 +1786,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 29, "me ```json { "jsonrpc": 2.0, - "id": 29, + "id": 32, "result": null } ``` @@ -1659,7 +1816,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 30, + "id": 33, "method": "org.rdk.TextTrack.setFontSize", "params": { "size": "CONTENT_DEFAULT" @@ -1671,7 +1828,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 30, "method": "org.rdk.TextTrack.setFontSize", "params": {"size": "CONTENT_DEFAULT"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 33, "method": "org.rdk.TextTrack.setFontSize", "params": {"size": "CONTENT_DEFAULT"}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1680,7 +1837,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 30, "me ```json { "jsonrpc": 2.0, - "id": 30, + "id": 33, "result": null } ``` @@ -1711,7 +1868,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 31, + "id": 34, "method": "org.rdk.TextTrack.setPreviewText", "params": { "sessionId": 1, @@ -1724,7 +1881,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 31, "method": "org.rdk.TextTrack.setPreviewText", "params": {"sessionId": 1, "text": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 34, "method": "org.rdk.TextTrack.setPreviewText", "params": {"sessionId": 1, "text": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1733,7 +1890,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 31, "me ```json { "jsonrpc": 2.0, - "id": 31, + "id": 34, "result": null } ``` @@ -1764,7 +1921,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 32, + "id": 35, "method": "org.rdk.TextTrack.setSessionClosedCaptionsService", "params": { "sessionId": 1, @@ -1777,7 +1934,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 32, "method": "org.rdk.TextTrack.setSessionClosedCaptionsService", "params": {"sessionId": 1, "service": "CC3"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 35, "method": "org.rdk.TextTrack.setSessionClosedCaptionsService", "params": {"sessionId": 1, "service": "CC3"}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1786,7 +1943,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 32, "me ```json { "jsonrpc": 2.0, - "id": 32, + "id": 35, "result": null } ``` @@ -1818,7 +1975,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 33, + "id": 36, "method": "org.rdk.TextTrack.setSessionDvbSubtitleSelection", "params": { "sessionId": 1, @@ -1832,7 +1989,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 33, "method": "org.rdk.TextTrack.setSessionDvbSubtitleSelection", "params": {"sessionId": 1, "compositionPageId": 0, "ancillaryPageId": 0}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 36, "method": "org.rdk.TextTrack.setSessionDvbSubtitleSelection", "params": {"sessionId": 1, "compositionPageId": 0, "ancillaryPageId": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1841,7 +1998,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 33, "me ```json { "jsonrpc": 2.0, - "id": 33, + "id": 36, "result": null } ``` @@ -1871,7 +2028,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 34, + "id": 37, "method": "org.rdk.TextTrack.setSessionSCTESelection", "params": { "sessionId": 1 @@ -1883,7 +2040,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 34, "method": "org.rdk.TextTrack.setSessionSCTESelection", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 37, "method": "org.rdk.TextTrack.setSessionSCTESelection", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1892,7 +2049,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 34, "me ```json { "jsonrpc": 2.0, - "id": 34, + "id": 37, "result": null } ``` @@ -1922,7 +2079,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 35, + "id": 38, "method": "org.rdk.TextTrack.setSessionTTMLSelection", "params": { "sessionId": 1 @@ -1934,7 +2091,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 35, "method": "org.rdk.TextTrack.setSessionTTMLSelection", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 38, "method": "org.rdk.TextTrack.setSessionTTMLSelection", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1943,7 +2100,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 35, "me ```json { "jsonrpc": 2.0, - "id": 35, + "id": 38, "result": null } ``` @@ -1974,7 +2131,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 36, + "id": 39, "method": "org.rdk.TextTrack.setSessionTeletextSelection", "params": { "sessionId": 1, @@ -1987,7 +2144,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 36, "method": "org.rdk.TextTrack.setSessionTeletextSelection", "params": {"sessionId": 1, "page": 0}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 39, "method": "org.rdk.TextTrack.setSessionTeletextSelection", "params": {"sessionId": 1, "page": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1996,7 +2153,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 36, "me ```json { "jsonrpc": 2.0, - "id": 36, + "id": 39, "result": null } ``` @@ -2026,7 +2183,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 37, + "id": 40, "method": "org.rdk.TextTrack.setSessionWebVTTSelection", "params": { "sessionId": 1 @@ -2038,7 +2195,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 37, "method": "org.rdk.TextTrack.setSessionWebVTTSelection", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 40, "method": "org.rdk.TextTrack.setSessionWebVTTSelection", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc ``` @@ -2047,7 +2204,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 37, "me ```json { "jsonrpc": 2.0, - "id": 37, + "id": 40, "result": null } ``` @@ -2077,7 +2234,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 38, + "id": 41, "method": "org.rdk.TextTrack.setTtmlStyleOverrides", "params": { "style": "" @@ -2089,7 +2246,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 38, "method": "org.rdk.TextTrack.setTtmlStyleOverrides", "params": {"style": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 41, "method": "org.rdk.TextTrack.setTtmlStyleOverrides", "params": {"style": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -2098,7 +2255,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 38, "me ```json { "jsonrpc": 2.0, - "id": 38, + "id": 41, "result": null } ``` @@ -2128,7 +2285,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 39, + "id": 42, "method": "org.rdk.TextTrack.setWindowColor", "params": { "color": "" @@ -2140,7 +2297,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 39, "method": "org.rdk.TextTrack.setWindowColor", "params": {"color": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 42, "method": "org.rdk.TextTrack.setWindowColor", "params": {"color": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -2149,7 +2306,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 39, "me ```json { "jsonrpc": 2.0, - "id": 39, + "id": 42, "result": null } ``` @@ -2179,7 +2336,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 40, + "id": 43, "method": "org.rdk.TextTrack.setWindowOpacity", "params": { "opacity": 0 @@ -2191,7 +2348,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 40, "method": "org.rdk.TextTrack.setWindowOpacity", "params": {"opacity": 0}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 43, "method": "org.rdk.TextTrack.setWindowOpacity", "params": {"opacity": 0}}' http://127.0.0.1:9998/jsonrpc ``` @@ -2200,7 +2357,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 40, "me ```json { "jsonrpc": 2.0, - "id": 40, + "id": 43, "result": null } ``` @@ -2230,7 +2387,7 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 41, + "id": 44, "method": "org.rdk.TextTrack.unMuteSession", "params": { "sessionId": 1 @@ -2242,7 +2399,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 41, "method": "org.rdk.TextTrack.unMuteSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 44, "method": "org.rdk.TextTrack.unMuteSession", "params": {"sessionId": 1}}' http://127.0.0.1:9998/jsonrpc ``` @@ -2251,7 +2408,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 41, "me ```json { "jsonrpc": 2.0, - "id": 41, + "id": 44, "result": null } ``` @@ -2298,7 +2455,7 @@ Notify backgroundColor Changed ```json { "jsonrpc": 2.0, - "id": 42, + "id": 45, "method": "org.rdk.TextTrack.onBackgroundColorChanged", "params": { "color": "" @@ -2322,7 +2479,7 @@ Notify backgroundOpacity Changed ```json { "jsonrpc": 2.0, - "id": 43, + "id": 46, "method": "org.rdk.TextTrack.onBackgroundOpacityChanged", "params": { "opacity": 0 @@ -2356,7 +2513,7 @@ The ClosedCaptionsStyle settings has changed. Call GetClosedCaptionsStyle() to g ```json { "jsonrpc": 2.0, - "id": 44, + "id": 47, "method": "org.rdk.TextTrack.onClosedCaptionsStyleChanged", "params": { "fontFamily": "CONTENT_DEFAULT", @@ -2389,7 +2546,7 @@ Notify fontColor Changed ```json { "jsonrpc": 2.0, - "id": 45, + "id": 48, "method": "org.rdk.TextTrack.onFontColorChanged", "params": { "color": "" @@ -2413,7 +2570,7 @@ Notify fontEdge Changed ```json { "jsonrpc": 2.0, - "id": 46, + "id": 49, "method": "org.rdk.TextTrack.onFontEdgeChanged", "params": { "edge": "CONTENT_DEFAULT" @@ -2437,7 +2594,7 @@ Notify fontEdgeColor Changed ```json { "jsonrpc": 2.0, - "id": 47, + "id": 50, "method": "org.rdk.TextTrack.onFontEdgeColorChanged", "params": { "color": "" @@ -2461,7 +2618,7 @@ Notify fontFamily Changed ```json { "jsonrpc": 2.0, - "id": 48, + "id": 51, "method": "org.rdk.TextTrack.onFontFamilyChanged", "params": { "font": "CONTENT_DEFAULT" @@ -2485,7 +2642,7 @@ Notify fontOpacity Changed ```json { "jsonrpc": 2.0, - "id": 49, + "id": 52, "method": "org.rdk.TextTrack.onFontOpacityChanged", "params": { "opacity": 0 @@ -2509,7 +2666,7 @@ Notify fontSize Changed ```json { "jsonrpc": 2.0, - "id": 50, + "id": 53, "method": "org.rdk.TextTrack.onFontSizeChanged", "params": { "size": "CONTENT_DEFAULT" @@ -2533,7 +2690,7 @@ The TTML Style override settings has changed. ```json { "jsonrpc": 2.0, - "id": 51, + "id": 54, "method": "org.rdk.TextTrack.onTtmlStyleOverridesChanged", "params": { "style": "" @@ -2557,7 +2714,7 @@ Notify windowColor Changed ```json { "jsonrpc": 2.0, - "id": 52, + "id": 55, "method": "org.rdk.TextTrack.onWindowColorChanged", "params": { "color": "" @@ -2581,7 +2738,7 @@ Notify windowOpacity Changed ```json { "jsonrpc": 2.0, - "id": 53, + "id": 56, "method": "org.rdk.TextTrack.onWindowOpacityChanged", "params": { "opacity": 0 diff --git a/docs/apis/WebKitBrowser.md b/docs/apis/WebKitBrowser.md index 87cbccf4..bb15bb45 100644 --- a/docs/apis/WebKitBrowser.md +++ b/docs/apis/WebKitBrowser.md @@ -2,7 +2,7 @@ # WebKitBrowser Plugin -**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/WebKitBrowser/IBrowser.h)** +**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/WebKitBrowser/IApplication.h)** A WebKitBrowser plugin for Thunder framework. @@ -48,12 +48,63 @@ WebKitBrowser interface methods: | Method | Description | | :-------- | :-------- | +| [reset](#reset) | Resets application data | | [addUserScript](#addUserScript) | Add user script to be executed at document start. | | [collectGarbage](#collectGarbage) | Initiate garbage collection | | [setcoookiejar](#setcoookiejar) | | | [removeAllUserScripts](#removeAllUserScripts) | Remove all user scripts. | | [runJavaScript](#runJavaScript) | Run javascript in main frame. | -| [reset](#reset) | Resets application data | + + +## *reset* + +Resets application data + +### Events +Event details will be updated soon. +### Parameters +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.type | string | Type of reset to perform | +### Results +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| result | null | On success null will be returned. | + +### Examples + + +#### Request + +```json +{ + "jsonrpc": 2.0, + "id": 0, + "method": "org.rdk.WebKitBrowser.reset", + "params": { + "type": "FACTORY" + } +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.WebKitBrowser.reset", "params": {"type": "FACTORY"}}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Response + +```json +{ + "jsonrpc": 2.0, + "id": 0, + "result": null +} +``` ## *addUserScript* @@ -304,57 +355,6 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met } ``` - -## *reset* - -Resets application data - -### Events -Event details will be updated soon. -### Parameters -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.type | string | Type of reset to perform | -### Results -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| result | null | On success null will be returned. | - -### Examples - - -#### Request - -```json -{ - "jsonrpc": 2.0, - "id": 0, - "method": "org.rdk.WebKitBrowser.reset", - "params": { - "type": "FACTORY" - } -} -``` - - -#### CURL Command - -```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 0, "method": "org.rdk.WebKitBrowser.reset", "params": {"type": "FACTORY"}}' http://127.0.0.1:9998/jsonrpc -``` - - -#### Response - -```json -{ - "jsonrpc": 2.0, - "id": 0, - "result": null -} -``` - # Properties @@ -364,6 +364,11 @@ WebKitBrowser interface properties: | Property | Description | | :-------- | :-------- | +| [contentLink](#contentLink)WO | URI of the associated application-specific content | +| [identifier](#identifier)RO | Application-specific identification string | +| [language](#language) | Current application user interface language | +| [launchPoint](#launchPoint) | Application launching point | +| [visible](#visible) | Current application visibility | | [bridgeEvent](#bridgeEvent)WO | Send legacy $badger | | [bridgeReply](#bridgeReply)WO | Response for legacy $badger. | | [fPS](#fPS)RO | Current framerate the browser is rendering at | @@ -376,63 +381,11 @@ WebKitBrowser interface properties: | [userScripts](#userScripts) | User scripts used by the browser | | [userStyleSheets](#userStyleSheets) | User style sheets used by the browser | | [visibility](#visibility) | Browser window visibility state | -| [contentLink](#contentLink)WO | URI of the associated application-specific content | -| [identifier](#identifier)RO | Application-specific identification string | -| [language](#language) | Current application user interface language | -| [launchPoint](#launchPoint) | Application launching point | -| [visible](#visible) | Current application visibility | - - -## *BridgeEvent* - -Send legacy $badger - -> This property is write-only. -### Events -Event details will be updated soon. -### Values -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| (property).payload | string | base64 encoded JSON string response to be delivered to $badger.callback | - -### Examples - - -#### Set Request - -```json -{ - "jsonrpc": 2.0, - "id": 11, - "method": "org.rdk.WebKitBrowser.bridgeEvent", - "params": { - "payload": "" - } -} -``` - - -#### CURL Command - -```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "method": "org.rdk.WebKitBrowser.bridgeEvent", "params": {"payload": ""}}' http://127.0.0.1:9998/jsonrpc -``` - - -#### Set Response - -```json -{ - "jsonrpc": 2.0, - "id": 11, - "result": null -} -``` - -## *BridgeReply* + +## *ContentLink* -Response for legacy $badger. +URI of the associated application-specific content > This property is write-only. ### Events @@ -440,7 +393,7 @@ Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).payload | string | base64 encoded JSON string response to be delivered to $badger.callback | +| (property).link | string | Content URI (e.g. https://youtube.com) | ### Examples @@ -450,10 +403,10 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 12, - "method": "org.rdk.WebKitBrowser.bridgeReply", + "id": 2, + "method": "org.rdk.WebKitBrowser.contentLink", "params": { - "payload": "" + "link": "" } } ``` @@ -462,7 +415,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "method": "org.rdk.WebKitBrowser.bridgeReply", "params": {"payload": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.WebKitBrowser.contentLink", "params": {"link": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -471,15 +424,15 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "me ```json { "jsonrpc": 2.0, - "id": 12, + "id": 2, "result": null } ``` - -## *FPS* + +## *Identifier* -Current framerate the browser is rendering at +Application-specific identification string > This property is read-only. ### Events @@ -487,7 +440,7 @@ Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).fps | integer | Current FPS | +| (property).id | string | Identifier string | ### Examples @@ -497,8 +450,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 13, - "method": "org.rdk.WebKitBrowser.fPS" + "id": 3, + "method": "org.rdk.WebKitBrowser.identifier" } ``` @@ -506,7 +459,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "method": "org.rdk.WebKitBrowser.fPS"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.WebKitBrowser.identifier"}' http://127.0.0.1:9998/jsonrpc ``` @@ -515,24 +468,24 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "me ```json { "jsonrpc": 2.0, - "id": 13, + "id": 3, "result": { - "fps": 0 + "id": "" } } ``` - -## *HTTPCookieAcceptPolicy* + +## *Language* -HTTP cookies accept policy +Current application user interface language ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).policy | string | HTTP Cookie Accept Policy Type (e.g. always) | +| (property).language | string | Language string as per RFC5646 (e.g. en) | ### Examples @@ -542,8 +495,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 14, - "method": "org.rdk.WebKitBrowser.hTTPCookieAcceptPolicy" + "id": 4, + "method": "org.rdk.WebKitBrowser.language" } ``` @@ -551,7 +504,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "method": "org.rdk.WebKitBrowser.hTTPCookieAcceptPolicy"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.WebKitBrowser.language"}' http://127.0.0.1:9998/jsonrpc ``` @@ -560,9 +513,9 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "me ```json { "jsonrpc": 2.0, - "id": 14, + "id": 4, "result": { - "policy": "ALWAYS" + "language": "" } } ``` @@ -573,10 +526,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "me ```json { "jsonrpc": 2.0, - "id": 14, - "method": "org.rdk.WebKitBrowser.hTTPCookieAcceptPolicy", + "id": 4, + "method": "org.rdk.WebKitBrowser.language", "params": { - "policy": "ALWAYS" + "language": "" } } ``` @@ -585,7 +538,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "me #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "method": "org.rdk.WebKitBrowser.hTTPCookieAcceptPolicy", "params": {"policy": "ALWAYS"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.WebKitBrowser.language", "params": {"language": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -594,22 +547,22 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "me ```json { "jsonrpc": 2.0, - "id": 14, + "id": 4, "result": null } ``` - -## *LocalStorageEnabled* + +## *LaunchPoint* -Controls the local storage availability +Application launching point ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).enabled | bool | | +| (property).point | string | | ### Examples @@ -619,8 +572,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 15, - "method": "org.rdk.WebKitBrowser.localStorageEnabled" + "id": 5, + "method": "org.rdk.WebKitBrowser.launchPoint" } ``` @@ -628,7 +581,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "method": "org.rdk.WebKitBrowser.localStorageEnabled"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.WebKitBrowser.launchPoint"}' http://127.0.0.1:9998/jsonrpc ``` @@ -637,9 +590,9 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "me ```json { "jsonrpc": 2.0, - "id": 15, + "id": 5, "result": { - "enabled": true + "point": "UNDEFINED" } } ``` @@ -650,10 +603,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "me ```json { "jsonrpc": 2.0, - "id": 15, - "method": "org.rdk.WebKitBrowser.localStorageEnabled", + "id": 5, + "method": "org.rdk.WebKitBrowser.launchPoint", "params": { - "enabled": true + "point": "UNDEFINED" } } ``` @@ -662,7 +615,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "me #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "method": "org.rdk.WebKitBrowser.localStorageEnabled", "params": {"enabled": true}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.WebKitBrowser.launchPoint", "params": {"point": "UNDEFINED"}}' http://127.0.0.1:9998/jsonrpc ``` @@ -671,22 +624,22 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "me ```json { "jsonrpc": 2.0, - "id": 15, + "id": 5, "result": null } ``` - -## *MixedContentPolicy* - -Mixed content policy + +## *Visible* + +Current application visibility ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).policy | string | Mixed content policy type | +| (property).visiblity | bool | | ### Examples @@ -696,8 +649,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 16, - "method": "org.rdk.WebKitBrowser.mixedContentPolicy" + "id": 6, + "method": "org.rdk.WebKitBrowser.visible" } ``` @@ -705,7 +658,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "method": "org.rdk.WebKitBrowser.mixedContentPolicy"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "method": "org.rdk.WebKitBrowser.visible"}' http://127.0.0.1:9998/jsonrpc ``` @@ -714,9 +667,9 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "me ```json { "jsonrpc": 2.0, - "id": 16, + "id": 6, "result": { - "policy": "ALLOWED" + "visiblity": true } } ``` @@ -727,10 +680,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "me ```json { "jsonrpc": 2.0, - "id": 16, - "method": "org.rdk.WebKitBrowser.mixedContentPolicy", + "id": 6, + "method": "org.rdk.WebKitBrowser.visible", "params": { - "policy": "ALLOWED" + "visiblity": true } } ``` @@ -739,7 +692,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "me #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "method": "org.rdk.WebKitBrowser.mixedContentPolicy", "params": {"policy": "ALLOWED"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "method": "org.rdk.WebKitBrowser.visible", "params": {"visiblity": true}}' http://127.0.0.1:9998/jsonrpc ``` @@ -748,33 +701,37 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "me ```json { "jsonrpc": 2.0, - "id": 16, + "id": 6, "result": null } ``` - -## *SecurityProfile* + +## *BridgeEvent* -Security profile for secure connections +Send legacy $badger +> This property is write-only. ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).profile | string | Security profile for secure connections (e.g. compatible) | +| (property).payload | string | base64 encoded JSON string response to be delivered to $badger.callback | ### Examples -#### Get Request +#### Set Request ```json { "jsonrpc": 2.0, - "id": 17, - "method": "org.rdk.WebKitBrowser.securityProfile" + "id": 11, + "method": "org.rdk.WebKitBrowser.bridgeEvent", + "params": { + "payload": "" + } } ``` @@ -782,32 +739,45 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "method": "org.rdk.WebKitBrowser.securityProfile"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 11, "method": "org.rdk.WebKitBrowser.bridgeEvent", "params": {"payload": ""}}' http://127.0.0.1:9998/jsonrpc ``` -#### Get Response +#### Set Response ```json { "jsonrpc": 2.0, - "id": 17, - "result": { - "profile": "" - } + "id": 11, + "result": null } ``` + +## *BridgeReply* + +Response for legacy $badger. + +> This property is write-only. +### Events +Event details will be updated soon. +### Values +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| (property).payload | string | base64 encoded JSON string response to be delivered to $badger.callback | + +### Examples + #### Set Request ```json { "jsonrpc": 2.0, - "id": 17, - "method": "org.rdk.WebKitBrowser.securityProfile", + "id": 12, + "method": "org.rdk.WebKitBrowser.bridgeReply", "params": { - "profile": "" + "payload": "" } } ``` @@ -816,7 +786,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "me #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "method": "org.rdk.WebKitBrowser.securityProfile", "params": {"profile": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 12, "method": "org.rdk.WebKitBrowser.bridgeReply", "params": {"payload": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -825,22 +795,23 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "me ```json { "jsonrpc": 2.0, - "id": 17, + "id": 12, "result": null } ``` - -## *URL* + +## *FPS* -Page loaded in the browser +Current framerate the browser is rendering at +> This property is read-only. ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).url | string | Loaded URL (e.g. https://example.com) | +| (property).fps | integer | Current FPS | ### Examples @@ -850,8 +821,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 18, - "method": "org.rdk.WebKitBrowser.uRL" + "id": 13, + "method": "org.rdk.WebKitBrowser.fPS" } ``` @@ -859,7 +830,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "method": "org.rdk.WebKitBrowser.uRL"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 13, "method": "org.rdk.WebKitBrowser.fPS"}' http://127.0.0.1:9998/jsonrpc ``` @@ -868,9 +839,54 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "me ```json { "jsonrpc": 2.0, - "id": 18, + "id": 13, "result": { - "url": "" + "fps": 0 + } +} +``` + + +## *HTTPCookieAcceptPolicy* + +HTTP cookies accept policy + +### Events +Event details will be updated soon. +### Values +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| (property).policy | string | HTTP Cookie Accept Policy Type (e.g. always) | + +### Examples + + +#### Get Request + +```json +{ + "jsonrpc": 2.0, + "id": 14, + "method": "org.rdk.WebKitBrowser.hTTPCookieAcceptPolicy" +} +``` + + +#### CURL Command + +```curl +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "method": "org.rdk.WebKitBrowser.hTTPCookieAcceptPolicy"}' http://127.0.0.1:9998/jsonrpc +``` + + +#### Get Response + +```json +{ + "jsonrpc": 2.0, + "id": 14, + "result": { + "policy": "ALWAYS" } } ``` @@ -881,10 +897,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "me ```json { "jsonrpc": 2.0, - "id": 18, - "method": "org.rdk.WebKitBrowser.uRL", + "id": 14, + "method": "org.rdk.WebKitBrowser.hTTPCookieAcceptPolicy", "params": { - "url": "" + "policy": "ALWAYS" } } ``` @@ -893,7 +909,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "me #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "method": "org.rdk.WebKitBrowser.uRL", "params": {"url": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 14, "method": "org.rdk.WebKitBrowser.hTTPCookieAcceptPolicy", "params": {"policy": "ALWAYS"}}' http://127.0.0.1:9998/jsonrpc ``` @@ -902,22 +918,22 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "me ```json { "jsonrpc": 2.0, - "id": 18, + "id": 14, "result": null } ``` - -## *UserAgent* + +## *LocalStorageEnabled* -UserAgent string used by the browser +Controls the local storage availability ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).useragent | string | UserAgent value (e.g. Mozilla/5.0 (Linux; x86_64 GNU/Linux) AppleWebKit/601.1 (KHTML, like Gecko) Version/8.0 Safari/601.1 WP) | +| (property).enabled | bool | | ### Examples @@ -927,8 +943,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 19, - "method": "org.rdk.WebKitBrowser.userAgent" + "id": 15, + "method": "org.rdk.WebKitBrowser.localStorageEnabled" } ``` @@ -936,7 +952,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "method": "org.rdk.WebKitBrowser.userAgent"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "method": "org.rdk.WebKitBrowser.localStorageEnabled"}' http://127.0.0.1:9998/jsonrpc ``` @@ -945,9 +961,9 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "me ```json { "jsonrpc": 2.0, - "id": 19, + "id": 15, "result": { - "useragent": "" + "enabled": true } } ``` @@ -958,10 +974,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "me ```json { "jsonrpc": 2.0, - "id": 19, - "method": "org.rdk.WebKitBrowser.userAgent", + "id": 15, + "method": "org.rdk.WebKitBrowser.localStorageEnabled", "params": { - "useragent": "" + "enabled": true } } ``` @@ -970,7 +986,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "me #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "method": "org.rdk.WebKitBrowser.userAgent", "params": {"useragent": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 15, "method": "org.rdk.WebKitBrowser.localStorageEnabled", "params": {"enabled": true}}' http://127.0.0.1:9998/jsonrpc ``` @@ -979,23 +995,22 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "me ```json { "jsonrpc": 2.0, - "id": 19, + "id": 15, "result": null } ``` - -## *UserScripts* + +## *MixedContentPolicy* -User scripts used by the browser +Mixed content policy ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).uris | IStringIterator | JSON array containing URIs pointing to user scripts, supported protocols: file:// | -| (property).uris[#] | string | | +| (property).policy | string | Mixed content policy type | ### Examples @@ -1005,8 +1020,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 20, - "method": "org.rdk.WebKitBrowser.userScripts" + "id": 16, + "method": "org.rdk.WebKitBrowser.mixedContentPolicy" } ``` @@ -1014,7 +1029,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "method": "org.rdk.WebKitBrowser.userScripts"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "method": "org.rdk.WebKitBrowser.mixedContentPolicy"}' http://127.0.0.1:9998/jsonrpc ``` @@ -1023,10 +1038,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "me ```json { "jsonrpc": 2.0, - "id": 20, - "result": [ - "" - ] + "id": 16, + "result": { + "policy": "ALLOWED" + } } ``` @@ -1036,11 +1051,11 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "me ```json { "jsonrpc": 2.0, - "id": 20, - "method": "org.rdk.WebKitBrowser.userScripts", - "params": [ - "" - ] + "id": 16, + "method": "org.rdk.WebKitBrowser.mixedContentPolicy", + "params": { + "policy": "ALLOWED" + } } ``` @@ -1048,7 +1063,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "me #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "method": "org.rdk.WebKitBrowser.userScripts", "params": [""]}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 16, "method": "org.rdk.WebKitBrowser.mixedContentPolicy", "params": {"policy": "ALLOWED"}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1057,23 +1072,22 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "me ```json { "jsonrpc": 2.0, - "id": 20, + "id": 16, "result": null } ``` - -## *UserStyleSheets* + +## *SecurityProfile* -User style sheets used by the browser +Security profile for secure connections ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).uris | IStringIterator | JSON array containing URIs pointing to user scripts, supported protocols: file:// | -| (property).uris[#] | string | | +| (property).profile | string | Security profile for secure connections (e.g. compatible) | ### Examples @@ -1083,8 +1097,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 21, - "method": "org.rdk.WebKitBrowser.userStyleSheets" + "id": 17, + "method": "org.rdk.WebKitBrowser.securityProfile" } ``` @@ -1092,7 +1106,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "method": "org.rdk.WebKitBrowser.userStyleSheets"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "method": "org.rdk.WebKitBrowser.securityProfile"}' http://127.0.0.1:9998/jsonrpc ``` @@ -1101,10 +1115,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "me ```json { "jsonrpc": 2.0, - "id": 21, - "result": [ - "" - ] + "id": 17, + "result": { + "profile": "" + } } ``` @@ -1114,11 +1128,11 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "me ```json { "jsonrpc": 2.0, - "id": 21, - "method": "org.rdk.WebKitBrowser.userStyleSheets", - "params": [ - "" - ] + "id": 17, + "method": "org.rdk.WebKitBrowser.securityProfile", + "params": { + "profile": "" + } } ``` @@ -1126,7 +1140,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "me #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "method": "org.rdk.WebKitBrowser.userStyleSheets", "params": [""]}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 17, "method": "org.rdk.WebKitBrowser.securityProfile", "params": {"profile": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1135,22 +1149,22 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "me ```json { "jsonrpc": 2.0, - "id": 21, + "id": 17, "result": null } ``` - -## *Visibility* + +## *URL* -Browser window visibility state +Page loaded in the browser ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).visible | string | Visiblity state (e.g. ) | +| (property).url | string | Loaded URL (e.g. https://example.com) | ### Examples @@ -1160,8 +1174,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 22, - "method": "org.rdk.WebKitBrowser.visibility" + "id": 18, + "method": "org.rdk.WebKitBrowser.uRL" } ``` @@ -1169,7 +1183,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "method": "org.rdk.WebKitBrowser.visibility"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "method": "org.rdk.WebKitBrowser.uRL"}' http://127.0.0.1:9998/jsonrpc ``` @@ -1178,9 +1192,9 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "me ```json { "jsonrpc": 2.0, - "id": 22, + "id": 18, "result": { - "visible": "HIDDEN" + "url": "" } } ``` @@ -1191,10 +1205,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "me ```json { "jsonrpc": 2.0, - "id": 22, - "method": "org.rdk.WebKitBrowser.visibility", + "id": 18, + "method": "org.rdk.WebKitBrowser.uRL", "params": { - "visible": "HIDDEN" + "url": "" } } ``` @@ -1203,7 +1217,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "me #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "method": "org.rdk.WebKitBrowser.visibility", "params": {"visible": "HIDDEN"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 18, "method": "org.rdk.WebKitBrowser.uRL", "params": {"url": ""}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1212,37 +1226,33 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "me ```json { "jsonrpc": 2.0, - "id": 22, + "id": 18, "result": null } ``` - -## *ContentLink* + +## *UserAgent* -URI of the associated application-specific content +UserAgent string used by the browser -> This property is write-only. ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).link | string | Content URI (e.g. https://youtube.com) | +| (property).useragent | string | UserAgent value (e.g. Mozilla/5.0 (Linux; x86_64 GNU/Linux) AppleWebKit/601.1 (KHTML, like Gecko) Version/8.0 Safari/601.1 WP) | ### Examples -#### Set Request +#### Get Request ```json { "jsonrpc": 2.0, - "id": 2, - "method": "org.rdk.WebKitBrowser.contentLink", - "params": { - "link": "" - } + "id": 19, + "method": "org.rdk.WebKitBrowser.userAgent" } ``` @@ -1250,43 +1260,33 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 2, "method": "org.rdk.WebKitBrowser.contentLink", "params": {"link": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "method": "org.rdk.WebKitBrowser.userAgent"}' http://127.0.0.1:9998/jsonrpc ``` -#### Set Response +#### Get Response ```json { "jsonrpc": 2.0, - "id": 2, - "result": null + "id": 19, + "result": { + "useragent": "" + } } ``` - -## *Identifier* - -Application-specific identification string - -> This property is read-only. -### Events -Event details will be updated soon. -### Values -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| (property).id | string | Identifier string | -### Examples - - -#### Get Request +#### Set Request ```json { "jsonrpc": 2.0, - "id": 3, - "method": "org.rdk.WebKitBrowser.identifier" + "id": 19, + "method": "org.rdk.WebKitBrowser.userAgent", + "params": { + "useragent": "" + } } ``` @@ -1294,33 +1294,32 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 3, "method": "org.rdk.WebKitBrowser.identifier"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 19, "method": "org.rdk.WebKitBrowser.userAgent", "params": {"useragent": ""}}' http://127.0.0.1:9998/jsonrpc ``` -#### Get Response +#### Set Response ```json { "jsonrpc": 2.0, - "id": 3, - "result": { - "id": "" - } + "id": 19, + "result": null } ``` - -## *Language* + +## *UserScripts* -Current application user interface language +User scripts used by the browser ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).language | string | Language string as per RFC5646 (e.g. en) | +| (property).uris | IStringIterator | JSON array containing URIs pointing to user scripts, supported protocols: file:// | +| (property).uris[#] | string | | ### Examples @@ -1330,8 +1329,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 4, - "method": "org.rdk.WebKitBrowser.language" + "id": 20, + "method": "org.rdk.WebKitBrowser.userScripts" } ``` @@ -1339,7 +1338,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.WebKitBrowser.language"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "method": "org.rdk.WebKitBrowser.userScripts"}' http://127.0.0.1:9998/jsonrpc ``` @@ -1348,10 +1347,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met ```json { "jsonrpc": 2.0, - "id": 4, - "result": { - "language": "" - } + "id": 20, + "result": [ + "" + ] } ``` @@ -1361,11 +1360,11 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met ```json { "jsonrpc": 2.0, - "id": 4, - "method": "org.rdk.WebKitBrowser.language", - "params": { - "language": "" - } + "id": 20, + "method": "org.rdk.WebKitBrowser.userScripts", + "params": [ + "" + ] } ``` @@ -1373,7 +1372,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "method": "org.rdk.WebKitBrowser.language", "params": {"language": ""}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 20, "method": "org.rdk.WebKitBrowser.userScripts", "params": [""]}' http://127.0.0.1:9998/jsonrpc ``` @@ -1382,22 +1381,23 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 4, "met ```json { "jsonrpc": 2.0, - "id": 4, + "id": 20, "result": null } ``` - -## *LaunchPoint* + +## *UserStyleSheets* -Application launching point +User style sheets used by the browser ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).point | string | | +| (property).uris | IStringIterator | JSON array containing URIs pointing to user scripts, supported protocols: file:// | +| (property).uris[#] | string | | ### Examples @@ -1407,8 +1407,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 5, - "method": "org.rdk.WebKitBrowser.launchPoint" + "id": 21, + "method": "org.rdk.WebKitBrowser.userStyleSheets" } ``` @@ -1416,7 +1416,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.WebKitBrowser.launchPoint"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "method": "org.rdk.WebKitBrowser.userStyleSheets"}' http://127.0.0.1:9998/jsonrpc ``` @@ -1425,10 +1425,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "met ```json { "jsonrpc": 2.0, - "id": 5, - "result": { - "point": "UNDEFINED" - } + "id": 21, + "result": [ + "" + ] } ``` @@ -1438,11 +1438,11 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "met ```json { "jsonrpc": 2.0, - "id": 5, - "method": "org.rdk.WebKitBrowser.launchPoint", - "params": { - "point": "UNDEFINED" - } + "id": 21, + "method": "org.rdk.WebKitBrowser.userStyleSheets", + "params": [ + "" + ] } ``` @@ -1450,7 +1450,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "met #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "method": "org.rdk.WebKitBrowser.launchPoint", "params": {"point": "UNDEFINED"}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 21, "method": "org.rdk.WebKitBrowser.userStyleSheets", "params": [""]}' http://127.0.0.1:9998/jsonrpc ``` @@ -1459,22 +1459,22 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 5, "met ```json { "jsonrpc": 2.0, - "id": 5, + "id": 21, "result": null } ``` - -## *Visible* + +## *Visibility* -Current application visibility +Browser window visibility state ### Events Event details will be updated soon. ### Values | Name | Type | Description | | :-------- | :-------- | :-------- | -| (property).visiblity | bool | | +| (property).visible | string | Visiblity state (e.g. ) | ### Examples @@ -1484,8 +1484,8 @@ Event details will be updated soon. ```json { "jsonrpc": 2.0, - "id": 6, - "method": "org.rdk.WebKitBrowser.visible" + "id": 22, + "method": "org.rdk.WebKitBrowser.visibility" } ``` @@ -1493,7 +1493,7 @@ Event details will be updated soon. #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "method": "org.rdk.WebKitBrowser.visible"}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "method": "org.rdk.WebKitBrowser.visibility"}' http://127.0.0.1:9998/jsonrpc ``` @@ -1502,9 +1502,9 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "met ```json { "jsonrpc": 2.0, - "id": 6, + "id": 22, "result": { - "visiblity": true + "visible": "HIDDEN" } } ``` @@ -1515,10 +1515,10 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "met ```json { "jsonrpc": 2.0, - "id": 6, - "method": "org.rdk.WebKitBrowser.visible", + "id": 22, + "method": "org.rdk.WebKitBrowser.visibility", "params": { - "visiblity": true + "visible": "HIDDEN" } } ``` @@ -1527,7 +1527,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "met #### CURL Command ```curl -curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "method": "org.rdk.WebKitBrowser.visible", "params": {"visiblity": true}}' http://127.0.0.1:9998/jsonrpc +curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 22, "method": "org.rdk.WebKitBrowser.visibility", "params": {"visible": "HIDDEN"}}' http://127.0.0.1:9998/jsonrpc ``` @@ -1536,7 +1536,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 6, "met ```json { "jsonrpc": 2.0, - "id": 6, + "id": 22, "result": null } ``` @@ -1553,12 +1553,36 @@ WebKitBrowser interface events: | Event | Description | | :-------- | :-------- | +| [visibilityChange](#visibilityChange) | Signals a visibility change of the browser | | [cookieJarChanged](#cookieJarChanged) | Notifies that cookies were added, removed or modified. | | [loadFailed](#loadFailed) | Browser failed to load page | | [loadFinished](#loadFinished) | Initial HTML document has been completely loaded and parsed | | [pageClosure](#pageClosure) | Notifies that the web page requests to close its window | | [uRLChange](#uRLChange) | Signals a URL change in the browser | -| [visibilityChange](#visibilityChange) | Application visibility changes | + + +## *visibilityChange* + +Signals a visibility change of the browser + +### Parameters +| Name | Type | Description | +| :-------- | :-------- | :-------- | +| params | object | | +| params.hidden | bool | hidden (true) or visible (false) | + +### Examples + +```json +{ + "jsonrpc": 2.0, + "id": 10, + "method": "org.rdk.WebKitBrowser.visibilityChange", + "params": { + "hidden": true + } +} +``` ## *cookieJarChanged* @@ -1671,27 +1695,3 @@ Signals a URL change in the browser } } ``` - - -## *visibilityChange* - -Application visibility changes - -### Parameters -| Name | Type | Description | -| :-------- | :-------- | :-------- | -| params | object | | -| params.hidden | bool | Denotes if application is currently hidden | - -### Examples - -```json -{ - "jsonrpc": 2.0, - "id": 1, - "method": "org.rdk.WebKitBrowser.visibilityChange", - "params": { - "hidden": true - } -} -``` diff --git a/docs/apis/XCast.md b/docs/apis/XCast.md index 6e29ade7..412d96ed 100644 --- a/docs/apis/XCast.md +++ b/docs/apis/XCast.md @@ -55,7 +55,7 @@ XCast interface methods: | [getStandbyBehavior](#getStandbyBehavior) | Return current standby behavior option string set uisng setStandbyBehavior or default value | | [registerApplications](#registerApplications) | Registers an application | | [setApplicationState](#setApplicationState) | Triggered when the cast service receives an application state change notification from a client | -| [setEnabled](#setEnabled) | Enable or disable XCAST service @parm enabled: true for enabled or false for disabled | +| [setEnabled](#setEnabled) | Enable or disable XCAST service | | [setFriendlyName](#setFriendlyName) | Sets the friendly name of the device | | [setManufacturerName](#setManufacturerName) | Sets the manufacturer name of the device | | [setModelName](#setModelName) | Sets the model name of the device | @@ -492,7 +492,7 @@ curl -H 'content-type:text/plain;' --data-binary '{"jsonrpc": 2.0, "id": 7, "met ## *setEnabled* -Enable or disable XCAST service @parm enabled: true for enabled or false for disabled +Enable or disable XCAST service ### Events Event details will be updated soon. diff --git a/tools/md_generator/h2md/generate_md_from_header.py b/tools/md_generator/h2md/generate_md_from_header.py index 2ac8b610..844c4985 100644 --- a/tools/md_generator/h2md/generate_md_from_header.py +++ b/tools/md_generator/h2md/generate_md_from_header.py @@ -54,7 +54,7 @@ def combine_header_structures(main_structure, additional_structure): def get_header_files(folder_path): """Get all .h files from the specified folder.""" - return [f for f in os.listdir(folder_path) if f.endswith('.h')] + return sorted([f for f in os.listdir(folder_path) if f.endswith('.h')]) def create_logger(classname, logfile_path=None): diff --git a/tools/md_generator/h2md/header_file_parser.py b/tools/md_generator/h2md/header_file_parser.py index cc07aa7c..ccd7a7a6 100644 --- a/tools/md_generator/h2md/header_file_parser.py +++ b/tools/md_generator/h2md/header_file_parser.py @@ -44,6 +44,7 @@ class HeaderFileParser: ('json', 'doxygen', re.compile(r'(?:\/\*+|\*|\/\/)\s*(@json)(?:\s+|$)([\d\.]+)?(?:.*)')), ('property', 'doxygen', re.compile(r'(?:\/\*+|\*|\/\/)\s*@property\s*(.*)')), ('event', 'doxygen', re.compile(r'(?:\/\*+|\*|\/\/)\s*@event\s*(.*)')), + ('generictag', 'doxygen', re.compile(r'(?:\/\*+|\*|\/\/)\s*@\w+\s*(.*)')), ('comment', 'doxygen', re.compile(r'(?:\/\*+|\*|\/\/)\s*(.*)')), ('stubgenomit', 'doxygen', re.compile(r'(?:\/\*+|\*|\/\/)\s*(@stubgen:omit)')), ('enum', 'cpp_obj', re.compile(r'enum\s+(?:class\s)?([\w\d]+)\s*(?:\:\s*([\w\d\:\*]*))?\s*\{?')), @@ -76,7 +77,7 @@ class HeaderFileParser: 'enum_mem': re.compile(r'([\w\d\[\]]+)\s*(?:\=\s*([\w\d]+))?\s*(?:(?:(?:\/\*)|(?:\/\/))(.*)(?:\*\/)?)?'), 'struct': re.compile(r'struct\s+(?:EXTERNAL\s+)?([\w\d]+)\s*\{([\s\S]*?)\}\;?'), 'struct_mem': re.compile(r'([\w\d\:\*]+)\s+([\w\d\[\]]+)\;?\s*(?:(?:(?:\/\*)|(?:\/\/))(.*)(?:\*\/)?)?'), - 'method': re.compile(r'virtual\s+([\w\d\:]+)\s+([\w\d\:]+)\s*\((.*)\)\s*(?:(?:(?:const\s*)?\=\s*0)|(?:{\s*})\s*)\;?'), + 'method': re.compile(r'virtual\s+([\w\d\:]+)\s+([\w\d\:]+)\s*\((.*)\)\s*(?:(?:const\s*)?(?:(?:\=\s*0\s*\;?)|{.*}))'), 'method_param': re.compile(r'([\w\d\:\*]+)\s+([\w\d\[\]]+)\s*(?:\/\*(.*)\*\/)?') }